logan
ec9a7b8695
- 删「打印/导出 PDF」按钮与「是否有帮助」反馈组件（静态站无后端，纯摆设）及未使用 SVG 图标 - 文档去 Tauri/Gin 等实现层名词（本地代理/隧道等用户语义保留） - 5 页 markdown 首行 H1 与页面标题去重 - homepage dist 同步重建
246 lines
10 KiB
HTML
246 lines
10 KiB
HTML
<!doctype html>
|
||
<html lang="zh-CN">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||
<title>服务端 API 参考 · OpsxAPI 文档</title>
|
||
<meta name="description" content="OpsxAPI 接口工作台用户文档 — HTTP、GraphQL、WebSocket、SSE、Socket.IO、MQTT 一站式调试，支持 OpenAPI/Postman/cURL 等格式导入导出。">
|
||
<link rel="icon" href="data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 32 32'%3E%3Crect width='32' height='32' rx='7' fill='%232563eb'/%3E%3Ctext x='16' y='22' font-size='18' font-weight='bold' fill='%23fff' text-anchor='middle' font-family='sans-serif'%3EO%3C/text%3E%3C/svg%3E">
|
||
<link rel="icon" type="image/svg+xml" href="data:image/svg+xml,%3Csvg%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20viewBox%3D%220%200%2064%2064%22%3E%3Cdefs%3E%3ClinearGradient%20id%3D%22g%22%20x1%3D%220%22%20y1%3D%220%22%20x2%3D%2264%22%20y2%3D%2264%22%20gradientUnits%3D%22userSpaceOnUse%22%3E%3Cstop%20offset%3D%220%22%20stop-color%3D%22%232563EB%22%2F%3E%3Cstop%20offset%3D%221%22%20stop-color%3D%22%2306B6D4%22%2F%3E%3C%2FlinearGradient%3E%3C%2Fdefs%3E%3Crect%20width%3D%2264%22%20height%3D%2264%22%20rx%3D%2214%22%20fill%3D%22url%28%23g%29%22%2F%3E%3Cg%20stroke%3D%22%23fff%22%20stroke-width%3D%225%22%20stroke-linecap%3D%22round%22%20stroke-linejoin%3D%22round%22%20fill%3D%22none%22%3E%3Cpath%20d%3D%22M17%2025h26%22%2F%3E%3Cpath%20d%3D%22M37%2019l6%206-6%206%22%2F%3E%3Cpath%20d%3D%22M47%2039H21%22%2F%3E%3Cpath%20d%3D%22M27%2033l-6%206%206%206%22%2F%3E%3C%2Fg%3E%3C%2Fsvg%3E">
|
||
<link rel="stylesheet" href="/docs/assets/docs.css">
|
||
</head>
|
||
<body>
|
||
<svg xmlns="http://www.w3.org/2000/svg" style="display:none" aria-hidden="true">
|
||
<symbol id="i-menu" viewBox="0 0 24 24"><path d="M4 5h16" /> <path d="M4 12h16" /> <path d="M4 19h16" /></symbol>
|
||
<symbol id="i-search" viewBox="0 0 24 24"><path d="m21 21-4.34-4.34" /> <circle cx="11" cy="11" r="8" /></symbol>
|
||
</svg>
|
||
<header class="topbar">
|
||
<div class="topbar-inner">
|
||
<button class="menu-btn" id="menu-btn" aria-label="打开导航"><svg class="i"><use href="#i-menu"/></svg></button>
|
||
<a class="brand" href="/docs">
|
||
<span class="brand-logo"><svg width="28" height="28" viewBox="0 0 64 64" aria-label="OpsxAPI"><defs><linearGradient id="lg-docs" x1="0" y1="0" x2="64" y2="64" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#2563EB"/><stop offset="1" stop-color="#06B6D4"/></linearGradient></defs><rect width="64" height="64" rx="14" fill="url(#lg-docs)"/><g stroke="#fff" stroke-width="5" stroke-linecap="round" stroke-linejoin="round" fill="none"><path d="M17 25h26"/><path d="M37 19l6 6-6 6"/><path d="M47 39H21"/><path d="M27 33l-6 6 6 6"/></g></svg></span>
|
||
<span class="brand-name">OpsxAPI <em>文档</em></span>
|
||
</a>
|
||
<span class="ver-badge">v1.0</span>
|
||
<div class="search">
|
||
<input id="search-input" type="search" placeholder="搜索文档…" autocomplete="off" spellcheck="false">
|
||
<div class="search-panel" id="search-panel" hidden></div>
|
||
</div>
|
||
<nav class="top-links">
|
||
<a href="/home">官网</a>
|
||
<a href="/" target="_blank" rel="noopener">打开工作台 ↗</a>
|
||
</nav>
|
||
</div>
|
||
</header>
|
||
|
||
<div class="layout" id="layout">
|
||
<aside class="sidebar" id="sidebar">
|
||
|
||
<div class="nav-group">
|
||
<div class="nav-group-title">开始使用</div>
|
||
|
||
<a class="nav-link" href="/docs/intro">产品介绍</a>
|
||
|
||
<a class="nav-link" href="/docs/quickstart">快速开始</a>
|
||
|
||
<a class="nav-link" href="/docs/interface">界面导览</a>
|
||
|
||
</div>
|
||
|
||
<div class="nav-group">
|
||
<div class="nav-group-title">请求调试</div>
|
||
|
||
<a class="nav-link" href="/docs/http">发送 HTTP 请求</a>
|
||
|
||
<a class="nav-link" href="/docs/auth">接口鉴权</a>
|
||
|
||
<a class="nav-link" href="/docs/env">环境与变量</a>
|
||
|
||
<a class="nav-link" href="/docs/graphql">GraphQL</a>
|
||
|
||
<a class="nav-link" href="/docs/websocket">WebSocket</a>
|
||
|
||
<a class="nav-link" href="/docs/sse">SSE 事件流</a>
|
||
|
||
<a class="nav-link" href="/docs/socketio">Socket.IO</a>
|
||
|
||
<a class="nav-link" href="/docs/mqtt">MQTT</a>
|
||
|
||
</div>
|
||
|
||
<div class="nav-group">
|
||
<div class="nav-group-title">数据管理</div>
|
||
|
||
<a class="nav-link" href="/docs/import">数据导入</a>
|
||
|
||
<a class="nav-link" href="/docs/export">导出与代码生成</a>
|
||
|
||
<a class="nav-link" href="/docs/mock">Mock 数据</a>
|
||
|
||
<a class="nav-link" href="/docs/manage">集合与历史</a>
|
||
|
||
</div>
|
||
|
||
<div class="nav-group">
|
||
<div class="nav-group-title">自动化测试与 AI</div>
|
||
|
||
<a class="nav-link" href="/docs/testing">自动化测试</a>
|
||
|
||
<a class="nav-link" href="/docs/ai">AI 助手</a>
|
||
|
||
</div>
|
||
|
||
<div class="nav-group">
|
||
<div class="nav-group-title">账号与团队</div>
|
||
|
||
<a class="nav-link" href="/docs/account">账号与团队</a>
|
||
|
||
</div>
|
||
|
||
<div class="nav-group">
|
||
<div class="nav-group-title">参考</div>
|
||
|
||
<a class="nav-link" href="/docs/license">授权与激活</a>
|
||
|
||
<a class="nav-link active" href="/docs/server-api">服务端 API 参考</a>
|
||
|
||
<a class="nav-link" href="/docs/faq">常见问题</a>
|
||
|
||
</div>
|
||
|
||
<div class="sidebar-foot">© 2026 OpsxAPI · 本地优先的接口工作台</div>
|
||
</aside>
|
||
|
||
<main class="content">
|
||
<div class="breadcrumb">文档 <span>/</span> 参考 <span>/</span> 服务端 API 参考</div>
|
||
<h1 class="page-title">服务端 API 参考</h1>
|
||
<div class="page-meta">更新于 2026-09-17</div>
|
||
<article class="md">
|
||
<p>本地服务默认监听 <code>:8787</code>，可用环境变量 <code>OPSXAPI_ADDR</code> 修改。所有端点仅监听本机回环，供 Web UI 与桌面端调用。</p>
|
||
<h2 id="sec-1">端点总览</h2>
|
||
<table>
|
||
<thead>
|
||
<tr>
|
||
<th>方法</th>
|
||
<th>路径</th>
|
||
<th>用途</th>
|
||
</tr>
|
||
</thead>
|
||
<tbody>
|
||
<tr>
|
||
<td>GET</td>
|
||
<td><code>/health</code></td>
|
||
<td>健康检查</td>
|
||
</tr>
|
||
<tr>
|
||
<td>POST</td>
|
||
<td><code>/v1/proxy/http</code></td>
|
||
<td>HTTP 代理（全方法、自定义头、超时）</td>
|
||
</tr>
|
||
<tr>
|
||
<td>POST</td>
|
||
<td><code>/v1/proxy/http/stream</code></td>
|
||
<td>NDJSON 流式代理（SSE / chunked 透传）</td>
|
||
</tr>
|
||
<tr>
|
||
<td>POST</td>
|
||
<td><code>/v1/proxy/ws/connect</code></td>
|
||
<td>建立到目标 WS 的隧道会话</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GET</td>
|
||
<td><code>/v1/proxy/ws/attach</code></td>
|
||
<td>浏览器 attach 到隧道会话（双向桥接）</td>
|
||
</tr>
|
||
<tr>
|
||
<td>POST</td>
|
||
<td><code>/v1/proxy/ws/close</code></td>
|
||
<td>关闭隧道会话</td>
|
||
</tr>
|
||
<tr>
|
||
<td>GET</td>
|
||
<td><code>/docs</code></td>
|
||
<td>本文档站</td>
|
||
</tr>
|
||
</tbody>
|
||
</table>
|
||
<h2 id="sec-2">HTTP 代理</h2>
|
||
<pre><code class="language-bash">curl -s -X POST http://127.0.0.1:8787/v1/proxy/http \
|
||
-H 'Content-Type: application/json' \
|
||
-d '{"method":"GET","url":"https://httpbin.org/get","headers":{}}'
|
||
</code></pre>
|
||
<p>响应：</p>
|
||
<pre><code class="language-json">{
|
||
"status": 200,
|
||
"headers": { "content-type": "application/json" },
|
||
"body": "{ ... }",
|
||
"timeMs": 320,
|
||
"size": 274
|
||
}
|
||
</code></pre>
|
||
<p>请求体 <code>body.mode</code> 支持 <code>json</code> / <code>xml</code> / <code>text</code> / <code>html</code> / <code>urlencoded</code> / <code>form-data</code>，<code>raw</code> 为原始报文；<code>timeoutMs</code> 可选。</p>
|
||
<h2 id="sec-3">流式代理</h2>
|
||
<p>请求体与 HTTP 代理一致，响应为 NDJSON 事件流：</p>
|
||
<pre><code class="language-text">{"type":"meta","status":200,"headers":{...}}
|
||
{"type":"chunk","data":"<base64>","size":1024}
|
||
{"type":"end","timeMs":1200,"size":8192}
|
||
</code></pre>
|
||
<h2 id="sec-4">WebSocket 隧道</h2>
|
||
<pre><code class="language-bash"># 1. 建立会话（可带自定义 Header）
|
||
curl -s -X POST http://127.0.0.1:8787/v1/proxy/ws/connect \
|
||
-H 'Content-Type: application/json' \
|
||
-d '{"url":"wss://echo.example.com","headers":{"Authorization":"Bearer t"}}'
|
||
# → {"sessionId":"..."}
|
||
|
||
# 2. 浏览器 / 客户端 attach（普通 WebSocket）
|
||
# ws://127.0.0.1:8787/v1/proxy/ws/attach?sessionId=...
|
||
|
||
# 3. 关闭
|
||
curl -s -X POST http://127.0.0.1:8787/v1/proxy/ws/close \
|
||
-H 'Content-Type: application/json' -d '{"sessionId":"..."}'
|
||
</code></pre>
|
||
<p>attach 后第一条消息为控制帧 <code>{"type":"open"}</code>；此后浏览器与目标服务器双向透传。</p>
|
||
<h2 id="sec-5">安全边界</h2>
|
||
<ul>
|
||
<li>仅允许 <code>http/https</code>（代理）与 <code>ws/wss</code>（隧道）目标。</li>
|
||
<li>拒绝云元数据地址（169.254.169.254 等）防 SSRF。</li>
|
||
<li>单响应上限 10 MiB；隧道会话 10 分钟无活动自动回收。</li>
|
||
</ul>
|
||
<h2 id="sec-6">部署建议</h2>
|
||
<ul>
|
||
<li>私有化交付随授权提供发行包（<code>opsxapi-server</code> 单二进制 + 官网静态资源），解压即用，不依赖源码与构建工具链；</li>
|
||
<li>生产环境建议置于内网，并按需增加鉴权反向代理；数据目录（SQLite）做好备份策略。</li>
|
||
</ul>
|
||
|
||
</article>
|
||
|
||
<div class="pn-nav">
|
||
|
||
<a class="pn prev" href="/docs/license"><span class="pn-label">← 上一页</span><span class="pn-title">授权与激活</span></a>
|
||
|
||
|
||
<a class="pn next" href="/docs/faq"><span class="pn-label">下一页 →</span><span class="pn-title">常见问题</span></a>
|
||
|
||
</div>
|
||
|
||
|
||
</main>
|
||
|
||
<aside class="toc">
|
||
<div class="toc-title">本页目录</div>
|
||
<nav class="toc-nav">
|
||
<a class="toc-l2" href="#sec-1">端点总览</a>
|
||
<a class="toc-l2" href="#sec-2">HTTP 代理</a>
|
||
<a class="toc-l2" href="#sec-3">流式代理</a>
|
||
<a class="toc-l2" href="#sec-4">WebSocket 隧道</a>
|
||
<a class="toc-l2" href="#sec-5">安全边界</a>
|
||
<a class="toc-l2" href="#sec-6">部署建议</a>
|
||
|
||
</nav>
|
||
</aside>
|
||
</div>
|
||
|
||
<script src="/docs/assets/docs.js" defer></script>
|
||
</body>
|
||
</html>
|