Files
opsxapi/homepage/dist/docs/interface/index.html
T

249 lines
9.3 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!doctype html>
<html lang="zh-CN">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>界面导览 · 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>
</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 active" 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" 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> 界面导览</div>
<h1 class="page-title">界面导览</h1>
<div class="page-meta">更新于 2026-09-17</div>
<article class="md">
<p>OpsxAPI 主界面由「活动栏 + 顶栏 + 侧栏 + 标签页 + 编辑区」组成:</p>
<h2 id="sec-1">活动栏(最左窄栏)</h2>
<table>
<thead>
<tr>
<th>元素</th>
<th>作用</th>
</tr>
</thead>
<tbody>
<tr>
<td>空间徽标(顶部)</td>
<td>切换 本地空间 / 我的空间 / 团队空间;云端空间显示同步状态点</td>
</tr>
<tr>
<td>接口 / 历史 / 测试 / 文档 / Mock</td>
<td>主导航:接口工作台、请求历史、自动化测试、接口文档、Mock 管理</td>
</tr>
<tr>
<td>授权徽章</td>
<td>试用倒计时或已授权状态,点击进入 设置 → 授权</td>
</tr>
<tr>
<td>设置 / 账号</td>
<td>设置中心;账号菜单(团队管理、立即同步、退出登录)</td>
</tr>
</tbody>
</table>
<h2 id="sec-2">顶栏</h2>
<table>
<thead>
<tr>
<th>元素</th>
<th>作用</th>
</tr>
</thead>
<tbody>
<tr>
<td>+ 新建</td>
<td>六种协议请求 / 目录(默认建在第一个集合)</td>
</tr>
<tr>
<td>导入 / 导出</td>
<td>数据导入(十种格式)与导出对话框</td>
</tr>
<tr>
<td>环境选择器</td>
<td>切换当前环境(变量与前置 URL 随之生效),可直达环境管理</td>
</tr>
</tbody>
</table>
<h2 id="sec-3">左侧栏(接口 | 历史 分段)</h2>
<ul>
<li><strong>接口</strong>:集合树 — 点击请求在标签页打开,目录展开 / 折叠;<strong>右键</strong> 新建 / 重命名 / 复制 / 导出 / 删除;<strong>拖拽</strong>移动(支持跨集合);顶部搜索实时过滤。</li>
<li><strong>历史</strong>:最近请求自动归档(状态码 / 耗时),点击回跳对应接口,支持一键清空。</li>
</ul>
<h2 id="sec-4">标签页栏</h2>
<p>同时打开多个接口,中键或 × 关闭;右键支持「关闭其他 / 关闭全部」。正在连接中的实时协议标签会显示呼吸圆点。</p>
<h2 id="sec-5">请求编辑区(上半部分)</h2>
<p>按协议呈现不同编辑器:</p>
<table>
<thead>
<tr>
<th>协议</th>
<th>标签页</th>
</tr>
</thead>
<tbody>
<tr>
<td>HTTP</td>
<td>Params · Body · Headers · Cookies · Auth · 说明</td>
</tr>
<tr>
<td>GraphQL</td>
<td>Query · Variables · Headers · Auth</td>
</tr>
<tr>
<td>WebSocket</td>
<td>消息 · 握手配置 · 说明</td>
</tr>
<tr>
<td>SSE</td>
<td>事件流 · 连接配置 · 说明</td>
</tr>
<tr>
<td>Socket.IO</td>
<td>事件 · 连接配置 · 说明</td>
</tr>
<tr>
<td>MQTT</td>
<td>消息 · Broker / 订阅 · 发布 · 说明</td>
</tr>
</tbody>
</table>
<h2 id="sec-6">响应区(下半部分)</h2>
<ul>
<li><strong>HTTP / GraphQL</strong>:响应体(Pretty JSON 高亮)、Raw、响应头,右上角状态 / 耗时 / 大小 / 复制。</li>
<li><strong>实时协议</strong>:分色消息日志(接收 · 绿、发送 · 蓝、系统 · 灰、错误 · 红),顶部实时统计收发条数与连接时长。</li>
</ul>
</article>
<div class="pn-nav">
<a class="pn prev" href="/docs/quickstart"><span class="pn-label">← 上一页</span><span class="pn-title">快速开始</span></a>
<a class="pn next" href="/docs/http"><span class="pn-label">下一页 →</span><span class="pn-title">发送 HTTP 请求</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">顶栏</a>
<a class="toc-l2" href="#sec-3">左侧栏(接口 | 历史 分段)</a>
<a class="toc-l2" href="#sec-4">标签页栏</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>