968 lines
29 KiB
JavaScript
968 lines
29 KiB
JavaScript
const {
|
||
Controller,
|
||
} = require('egg');
|
||
const fs = require('fs').promises;
|
||
const path = require('path');
|
||
|
||
function escapeHtml(value) {
|
||
return String(value || '')
|
||
.replace(/&/g, '&')
|
||
.replace(/</g, '<')
|
||
.replace(/>/g, '>')
|
||
.replace(/"/g, '"')
|
||
.replace(/'/g, ''');
|
||
}
|
||
|
||
function toArray(value) {
|
||
return Array.isArray(value) ? value : [];
|
||
}
|
||
|
||
function slugify(value) {
|
||
return String(value || '')
|
||
.toLowerCase()
|
||
.replace(/[^a-z0-9\u4e00-\u9fa5]+/g, '-')
|
||
.replace(/(^-|-$)/g, '');
|
||
}
|
||
|
||
function normalizeGroups(docData) {
|
||
if (docData && docData.methods && Array.isArray(docData.methods.groups)) {
|
||
return docData.methods.groups.map(group => ({
|
||
groupName: group.groupName || group.module || 'Default',
|
||
module: group.module || '',
|
||
list: toArray(group.list),
|
||
}));
|
||
}
|
||
|
||
if (docData && Array.isArray(docData.endpoints)) {
|
||
return [{
|
||
groupName: 'Endpoints',
|
||
module: docData.module || '',
|
||
list: docData.endpoints,
|
||
}];
|
||
}
|
||
|
||
return [];
|
||
}
|
||
|
||
function renderKeyValueRows(items, keyMap) {
|
||
if (!items.length) {
|
||
return '<tr><td colspan="4" class="muted">暂无数据</td></tr>';
|
||
}
|
||
|
||
return items.map(item => {
|
||
return `<tr>
|
||
<td>${escapeHtml(item[keyMap.name] || '')}</td>
|
||
<td>${escapeHtml(item[keyMap.type] || '')}</td>
|
||
<td>${item[keyMap.required] ? '是' : '否'}</td>
|
||
<td>${escapeHtml(item[keyMap.description] || '')}</td>
|
||
</tr>`;
|
||
}).join('');
|
||
}
|
||
|
||
function renderGlobalHeadersControls(globalHeaders) {
|
||
const headers = toArray(globalHeaders);
|
||
if (!headers.length) {
|
||
return '<p class="muted">当前文档未定义额外全局 Header</p>';
|
||
}
|
||
|
||
return `<div class="global-headers-grid">${headers.map(item => {
|
||
const name = item.name || '';
|
||
const type = item.type || 'string';
|
||
const required = !!item.required;
|
||
const description = item.description || '';
|
||
const options = toArray(item.list);
|
||
|
||
const field = options.length
|
||
? `<select class="global-header-control" data-header-name="${escapeHtml(name)}" data-required="${required ? 'true' : 'false'}">
|
||
<option value="">请选择</option>
|
||
${options.map(option => `<option value="${escapeHtml(option.value || '')}">${escapeHtml(option.name || option.value || '')}</option>`).join('')}
|
||
</select>`
|
||
: `<input class="global-header-control" type="text" data-header-name="${escapeHtml(name)}" data-required="${required ? 'true' : 'false'}" placeholder="请输入 ${escapeHtml(name)}" />`;
|
||
|
||
return `<label class="global-header-item">
|
||
<span>${escapeHtml(name)}${required ? ' *' : ''}</span>
|
||
${field}
|
||
<small class="muted">${escapeHtml(description)} (${escapeHtml(type)})</small>
|
||
</label>`;
|
||
}).join('')}</div>`;
|
||
}
|
||
|
||
function renderMethodCard(item, entryPath, moduleName) {
|
||
const headers = toArray(item.headers);
|
||
const params = toArray(item.params);
|
||
const response = toArray(item.response);
|
||
const errors = toArray(item.errors);
|
||
const methodName = item.method || item.name || 'unknown';
|
||
const description = item.description || '';
|
||
const isQimen = moduleName === 'qimen';
|
||
const queryHint = isQimen
|
||
? 'app_key=xxx&method=...&v=2.0&format=json&sign_method=md5&sign=xxx×tamp=1700000000'
|
||
: `method=${methodName}&v=1.0×tamp=1700000000`;
|
||
|
||
return `<section class="method-card" id="${escapeHtml(methodName)}" data-method="${escapeHtml(methodName)}" data-desc="${escapeHtml(description)}" data-module="${escapeHtml(moduleName || '')}" data-endpoint="${escapeHtml(entryPath)}" data-login-required="${item.isNeedLogin ? 'true' : 'false'}">
|
||
<div class="method-header">
|
||
<div>
|
||
<h3>${escapeHtml(methodName)}</h3>
|
||
<p class="method-desc">${escapeHtml(description)}</p>
|
||
</div>
|
||
<div class="badges">
|
||
<span class="badge">入口: ${escapeHtml(entryPath)}</span>
|
||
<span class="badge">鉴权: ${item.isNeedAuth ? '是' : '否'}</span>
|
||
<span class="badge">登录: ${item.isNeedLogin ? '是' : '否'}</span>
|
||
</div>
|
||
</div>
|
||
|
||
<details>
|
||
<summary>Headers (${headers.length})</summary>
|
||
<table>
|
||
<thead><tr><th>名称</th><th>类型</th><th>必填</th><th>说明</th></tr></thead>
|
||
<tbody>${renderKeyValueRows(headers, {
|
||
name: 'name',
|
||
type: 'type',
|
||
required: 'required',
|
||
description: 'description',
|
||
})}</tbody>
|
||
</table>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Params (${params.length})</summary>
|
||
<table>
|
||
<thead><tr><th>名称</th><th>类型</th><th>必填</th><th>说明</th></tr></thead>
|
||
<tbody>${renderKeyValueRows(params, {
|
||
name: 'name',
|
||
type: 'type',
|
||
required: 'required',
|
||
description: 'description',
|
||
})}</tbody>
|
||
</table>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Response (${response.length})</summary>
|
||
<table>
|
||
<thead><tr><th>名称</th><th>类型</th><th>必填</th><th>说明</th></tr></thead>
|
||
<tbody>${renderKeyValueRows(response, {
|
||
name: 'name',
|
||
type: 'type',
|
||
required: 'required',
|
||
description: 'description',
|
||
})}</tbody>
|
||
</table>
|
||
</details>
|
||
|
||
<details>
|
||
<summary>Errors (${errors.length})</summary>
|
||
<table>
|
||
<thead><tr><th>名称</th><th>类型</th><th>必填</th><th>说明</th></tr></thead>
|
||
<tbody>${renderKeyValueRows(errors, {
|
||
name: 'code',
|
||
type: 'type',
|
||
required: 'required',
|
||
description: 'message',
|
||
})}</tbody>
|
||
</table>
|
||
</details>
|
||
|
||
<details class="debug-panel">
|
||
<summary>在线调试</summary>
|
||
<div class="debug-form">
|
||
<label>Query 参数</label>
|
||
<input class="req-query" type="text" placeholder="${escapeHtml(queryHint)}" />
|
||
|
||
<label>Body (JSON)</label>
|
||
<textarea class="req-body" rows="6" placeholder='{}'></textarea>
|
||
|
||
<div class="debug-actions">
|
||
<button type="button" class="send-btn">发送 POST 请求</button>
|
||
<span class="muted">${item.isNeedLogin ? '该接口需要登录,未设置 Token 将阻止请求' : '该接口无需登录,可不设置 Token 直接调试'}</span>
|
||
</div>
|
||
|
||
<pre class="req-result muted">点击发送后显示响应</pre>
|
||
</div>
|
||
</details>
|
||
</section>`;
|
||
}
|
||
|
||
function renderHtmlPage({
|
||
docName,
|
||
docData,
|
||
groups,
|
||
docs,
|
||
entryPath,
|
||
}) {
|
||
const methodsCount = groups.reduce((sum, group) => sum + toArray(group.list).length, 0);
|
||
const globalHeaders = toArray(docData.headers);
|
||
const globalHeadersControls = renderGlobalHeadersControls(globalHeaders);
|
||
const navHtml = docs.map(name => {
|
||
const activeClass = name === docName ? 'active' : '';
|
||
return `<a class="tab ${activeClass}" href="/api/docs/${encodeURIComponent(name)}">${escapeHtml(name)}</a>`;
|
||
}).join('');
|
||
|
||
const sidebarHtml = groups.map((group, index) => {
|
||
const list = toArray(group.list);
|
||
const groupKey = slugify(group.module || group.groupName || `group-${index}`) || `group-${index}`;
|
||
const methodsHtml = list.map(item => {
|
||
const methodName = item.method || item.name || 'unknown';
|
||
const desc = item.description || '';
|
||
return `<li class="nav-item" data-method="${escapeHtml(methodName)}" data-desc="${escapeHtml(desc)}">
|
||
<a href="#${escapeHtml(methodName)}" title="${escapeHtml(desc)}">${escapeHtml(methodName)}</a>
|
||
</li>`;
|
||
}).join('');
|
||
|
||
return `<details class="nav-group" data-group-key="${escapeHtml(groupKey)}" ${index === 0 ? 'open' : ''}>
|
||
<summary>${escapeHtml(group.groupName)} <span class="count">${list.length}</span></summary>
|
||
<ul>${methodsHtml || '<li class="muted">暂无方法</li>'}</ul>
|
||
</details>`;
|
||
}).join('');
|
||
|
||
const groupHtml = groups.map(group => {
|
||
const list = toArray(group.list);
|
||
const groupKey = slugify(group.module || group.groupName) || 'group';
|
||
const cards = list.map(item => renderMethodCard(item, entryPath, docData.module)).join('');
|
||
return `<section class="group-block" data-group-key="${escapeHtml(groupKey)}">
|
||
<h2>${escapeHtml(group.groupName)} <small>${escapeHtml(group.module || '')}</small></h2>
|
||
${cards || '<p class="muted">该分组暂无方法定义</p>'}
|
||
</section>`;
|
||
}).join('');
|
||
|
||
return `<!doctype html>
|
||
<html lang="zh-CN">
|
||
<head>
|
||
<meta charset="UTF-8" />
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||
<title>${escapeHtml(docName)} API 文档</title>
|
||
<style>
|
||
:root {
|
||
--bg: #f4f6fb;
|
||
--card: #ffffff;
|
||
--line: #dbe1ee;
|
||
--text: #1f2a44;
|
||
--muted: #62708a;
|
||
--accent: #1565c0;
|
||
--accent-soft: #e8f1fc;
|
||
}
|
||
* { box-sizing: border-box; }
|
||
body {
|
||
margin: 0;
|
||
font-family: "Segoe UI", "PingFang SC", "Microsoft YaHei", sans-serif;
|
||
color: var(--text);
|
||
background: radial-gradient(circle at 20% 0%, #e9f2ff 0, var(--bg) 45%), var(--bg);
|
||
}
|
||
.container { max-width: 1180px; margin: 0 auto; padding: 24px; }
|
||
.hero {
|
||
background: var(--card);
|
||
border: 1px solid var(--line);
|
||
border-radius: 12px;
|
||
padding: 20px;
|
||
box-shadow: 0 6px 20px rgba(18, 48, 102, 0.08);
|
||
}
|
||
.hero h1 { margin: 0 0 8px; }
|
||
.meta { color: var(--muted); display: flex; gap: 16px; flex-wrap: wrap; }
|
||
.tabs { margin-top: 16px; display: flex; gap: 10px; flex-wrap: wrap; }
|
||
.tab {
|
||
text-decoration: none;
|
||
color: var(--accent);
|
||
border: 1px solid #b9d4f3;
|
||
background: #f5faff;
|
||
padding: 7px 12px;
|
||
border-radius: 999px;
|
||
font-size: 14px;
|
||
}
|
||
.tab.active { background: var(--accent); color: white; border-color: var(--accent); }
|
||
.global-auth {
|
||
margin-top: 14px;
|
||
border: 1px solid #c9dbf3;
|
||
background: #f6faff;
|
||
border-radius: 10px;
|
||
padding: 12px;
|
||
}
|
||
.global-auth h3 { margin: 0 0 8px; font-size: 15px; }
|
||
.global-auth .row {
|
||
display: flex;
|
||
gap: 10px;
|
||
flex-wrap: wrap;
|
||
align-items: center;
|
||
}
|
||
.global-auth input {
|
||
flex: 1;
|
||
min-width: 300px;
|
||
padding: 8px 10px;
|
||
border: 1px solid #b5ccec;
|
||
border-radius: 8px;
|
||
font-size: 13px;
|
||
}
|
||
.global-auth button {
|
||
border: 1px solid #9fc2eb;
|
||
background: #fff;
|
||
color: #174c94;
|
||
border-radius: 8px;
|
||
padding: 8px 12px;
|
||
cursor: pointer;
|
||
}
|
||
.global-headers-grid {
|
||
display: grid;
|
||
grid-template-columns: repeat(auto-fit, minmax(220px, 1fr));
|
||
gap: 10px;
|
||
margin-bottom: 8px;
|
||
}
|
||
.global-header-item {
|
||
display: grid;
|
||
gap: 6px;
|
||
font-size: 13px;
|
||
color: #21466f;
|
||
}
|
||
.global-header-item span {
|
||
font-weight: 600;
|
||
}
|
||
.global-header-item input,
|
||
.global-header-item select {
|
||
border: 1px solid #b5ccec;
|
||
border-radius: 8px;
|
||
padding: 8px 10px;
|
||
font-size: 13px;
|
||
background: #fff;
|
||
color: #1f2a44;
|
||
}
|
||
.global-header-item small {
|
||
line-height: 1.2;
|
||
}
|
||
.group-block { margin-top: 18px; }
|
||
.layout {
|
||
margin-top: 16px;
|
||
display: grid;
|
||
grid-template-columns: 320px 1fr;
|
||
gap: 16px;
|
||
align-items: start;
|
||
}
|
||
.sidebar {
|
||
position: sticky;
|
||
top: 12px;
|
||
background: var(--card);
|
||
border: 1px solid var(--line);
|
||
border-radius: 12px;
|
||
padding: 12px;
|
||
max-height: calc(100vh - 24px);
|
||
overflow: auto;
|
||
box-shadow: 0 6px 20px rgba(18, 48, 102, 0.06);
|
||
}
|
||
.search-box {
|
||
display: grid;
|
||
gap: 8px;
|
||
margin-bottom: 10px;
|
||
}
|
||
.search-box input {
|
||
width: 100%;
|
||
border: 1px solid #b5ccec;
|
||
border-radius: 8px;
|
||
padding: 8px 10px;
|
||
font-size: 13px;
|
||
}
|
||
.search-actions {
|
||
display: flex;
|
||
gap: 8px;
|
||
flex-wrap: wrap;
|
||
}
|
||
.search-actions button {
|
||
border: 1px solid #b5ccec;
|
||
border-radius: 8px;
|
||
background: #fff;
|
||
color: #174c94;
|
||
padding: 6px 10px;
|
||
cursor: pointer;
|
||
font-size: 12px;
|
||
}
|
||
.nav-group {
|
||
border: 1px solid #d7e4f7;
|
||
border-radius: 8px;
|
||
background: #fcfdff;
|
||
padding: 8px;
|
||
margin-bottom: 8px;
|
||
}
|
||
.nav-group summary {
|
||
display: flex;
|
||
justify-content: space-between;
|
||
align-items: center;
|
||
color: #1a4c8f;
|
||
font-size: 13px;
|
||
font-weight: 700;
|
||
}
|
||
.nav-group .count {
|
||
background: #e9f2ff;
|
||
border: 1px solid #c7dbf5;
|
||
border-radius: 999px;
|
||
padding: 2px 8px;
|
||
font-size: 11px;
|
||
color: #174c94;
|
||
}
|
||
.nav-group ul {
|
||
list-style: none;
|
||
padding: 8px 0 0;
|
||
margin: 0;
|
||
}
|
||
.nav-item {
|
||
margin-bottom: 4px;
|
||
border-radius: 6px;
|
||
}
|
||
.nav-item a {
|
||
display: block;
|
||
color: #32547f;
|
||
text-decoration: none;
|
||
font-size: 12px;
|
||
padding: 6px 8px;
|
||
border-radius: 6px;
|
||
word-break: break-all;
|
||
}
|
||
.nav-item a:hover {
|
||
background: #eef5ff;
|
||
color: #123e79;
|
||
}
|
||
.doc-content {
|
||
min-width: 0;
|
||
}
|
||
.group-block h2 { margin: 0 0 12px; }
|
||
.group-block small { color: var(--muted); font-weight: normal; }
|
||
.method-card {
|
||
background: var(--card);
|
||
border: 1px solid var(--line);
|
||
border-radius: 10px;
|
||
padding: 16px;
|
||
margin-bottom: 14px;
|
||
}
|
||
.method-header {
|
||
display: flex;
|
||
justify-content: space-between;
|
||
gap: 12px;
|
||
flex-wrap: wrap;
|
||
align-items: flex-start;
|
||
}
|
||
.method-header h3 { margin: 0 0 8px; }
|
||
.method-header p { margin: 0; color: var(--muted); }
|
||
.badges { display: flex; gap: 8px; flex-wrap: wrap; }
|
||
.badge {
|
||
border-radius: 999px;
|
||
padding: 5px 10px;
|
||
background: var(--accent-soft);
|
||
color: #174c94;
|
||
font-size: 12px;
|
||
border: 1px solid #c8def6;
|
||
white-space: nowrap;
|
||
}
|
||
details { margin-top: 12px; }
|
||
summary { cursor: pointer; color: #103f7a; font-weight: 600; }
|
||
.debug-panel {
|
||
border: 1px dashed #c6d9f2;
|
||
border-radius: 8px;
|
||
padding: 10px;
|
||
background: #fbfdff;
|
||
}
|
||
.debug-form {
|
||
display: grid;
|
||
gap: 8px;
|
||
margin-top: 10px;
|
||
}
|
||
.debug-form label {
|
||
color: #254974;
|
||
font-size: 13px;
|
||
font-weight: 600;
|
||
}
|
||
.debug-form input,
|
||
.debug-form textarea {
|
||
width: 100%;
|
||
border: 1px solid #b5ccec;
|
||
border-radius: 8px;
|
||
padding: 8px 10px;
|
||
font-size: 13px;
|
||
font-family: ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, "Liberation Mono", "Courier New", monospace;
|
||
background: #fff;
|
||
}
|
||
.debug-actions {
|
||
display: flex;
|
||
gap: 10px;
|
||
align-items: center;
|
||
flex-wrap: wrap;
|
||
}
|
||
.send-btn {
|
||
border: 1px solid #0f5cb2;
|
||
background: #1565c0;
|
||
color: #fff;
|
||
border-radius: 8px;
|
||
padding: 8px 12px;
|
||
cursor: pointer;
|
||
}
|
||
.send-btn:disabled {
|
||
opacity: 0.6;
|
||
cursor: not-allowed;
|
||
}
|
||
.req-result {
|
||
margin: 0;
|
||
min-height: 80px;
|
||
max-height: 260px;
|
||
overflow: auto;
|
||
background: #0d1d33;
|
||
color: #d8e7ff;
|
||
border-radius: 8px;
|
||
padding: 10px;
|
||
font-size: 12px;
|
||
}
|
||
table {
|
||
width: 100%;
|
||
border-collapse: collapse;
|
||
margin-top: 8px;
|
||
background: #fff;
|
||
}
|
||
th, td {
|
||
border: 1px solid var(--line);
|
||
padding: 8px 10px;
|
||
text-align: left;
|
||
vertical-align: top;
|
||
font-size: 13px;
|
||
}
|
||
th { background: #f6f9ff; }
|
||
.muted { color: var(--muted); }
|
||
@media (max-width: 768px) {
|
||
.container { padding: 14px; }
|
||
.method-card { padding: 12px; }
|
||
.layout { grid-template-columns: 1fr; }
|
||
.sidebar {
|
||
position: static;
|
||
max-height: none;
|
||
}
|
||
}
|
||
</style>
|
||
</head>
|
||
<body>
|
||
<main class="container">
|
||
<section class="hero">
|
||
<h1>${escapeHtml(docData.module || docName)} API 文档</h1>
|
||
<div class="meta">
|
||
<span>说明: ${escapeHtml(docData.description || '无')}</span>
|
||
<span>版本: ${escapeHtml(docData.version || 'N/A')}</span>
|
||
<span>更新: ${escapeHtml(docData.updatedAt || 'N/A')}</span>
|
||
<span>方法数: ${methodsCount}</span>
|
||
<span>统一入口: <strong>${escapeHtml(entryPath)}</strong></span>
|
||
</div>
|
||
<div class="tabs">
|
||
${navHtml}
|
||
<a class="tab" href="/api/docs/${encodeURIComponent(docName)}/raw">查看 JSON</a>
|
||
</div>
|
||
<div class="global-auth">
|
||
<h3>全局 Authorization</h3>
|
||
<div class="row">
|
||
<input id="globalAuth" type="text" placeholder="Bearer xxxxx" />
|
||
<button type="button" id="clearAuthBtn">清空</button>
|
||
</div>
|
||
<p class="muted">设置后会自动注入所有“在线调试”请求头,保存在浏览器本地。</p>
|
||
<h3>全局业务 Header</h3>
|
||
${globalHeadersControls}
|
||
<p class="muted">来自 JSON 的 headers 定义;带 * 的字段为必填,支持下拉 list 选择。</p>
|
||
</div>
|
||
</section>
|
||
|
||
<section class="layout">
|
||
<aside class="sidebar">
|
||
<div class="search-box">
|
||
<input id="methodSearch" type="text" placeholder="快速搜索: 方法名 / 描述" />
|
||
<div class="search-actions">
|
||
<button type="button" id="expandAllBtn">展开全部</button>
|
||
<button type="button" id="collapseAllBtn">折叠全部</button>
|
||
</div>
|
||
<p id="searchStats" class="muted">共 ${methodsCount} 个方法</p>
|
||
</div>
|
||
${sidebarHtml || '<p class="muted">暂无导航数据</p>'}
|
||
</aside>
|
||
|
||
<section class="doc-content">
|
||
${groupHtml || '<p class="muted">暂无可展示的方法定义</p>'}
|
||
</section>
|
||
</section>
|
||
</main>
|
||
<script>
|
||
(function() {
|
||
var AUTH_KEY = 'wms_docs_global_auth';
|
||
var HEADER_STORE_KEY = 'wms_docs_global_headers_' + ${JSON.stringify(docName)};
|
||
var authInput = document.getElementById('globalAuth');
|
||
var clearBtn = document.getElementById('clearAuthBtn');
|
||
var searchInput = document.getElementById('methodSearch');
|
||
var searchStats = document.getElementById('searchStats');
|
||
var expandAllBtn = document.getElementById('expandAllBtn');
|
||
var collapseAllBtn = document.getElementById('collapseAllBtn');
|
||
|
||
function nowTimestamp() {
|
||
return Math.floor(Date.now() / 1000);
|
||
}
|
||
|
||
function formatPretty(text) {
|
||
try {
|
||
return JSON.stringify(JSON.parse(text), null, 2);
|
||
} catch (e) {
|
||
return text;
|
||
}
|
||
}
|
||
|
||
function buildDefaultQuery(card) {
|
||
var moduleName = card.getAttribute('data-module') || '';
|
||
var methodName = card.getAttribute('data-method') || '';
|
||
if (moduleName === 'qimen') {
|
||
return 'app_key=&method=' + encodeURIComponent(methodName)
|
||
+ '&v=2.0&format=json&sign_method=md5&sign=×tamp=' + nowTimestamp();
|
||
}
|
||
return 'method=' + encodeURIComponent(methodName) + '&v=1.0×tamp=' + nowTimestamp();
|
||
}
|
||
|
||
function initDefaultQueries() {
|
||
var cards = document.querySelectorAll('.method-card');
|
||
cards.forEach(function(card) {
|
||
var queryInput = card.querySelector('.req-query');
|
||
var bodyInput = card.querySelector('.req-body');
|
||
if (queryInput && !queryInput.value.trim()) {
|
||
queryInput.value = buildDefaultQuery(card);
|
||
}
|
||
if (bodyInput && !bodyInput.value.trim()) {
|
||
bodyInput.value = '{}';
|
||
}
|
||
});
|
||
}
|
||
|
||
function normalizeText(text) {
|
||
return String(text || '').toLowerCase();
|
||
}
|
||
|
||
function getGlobalHeaderControls() {
|
||
return document.querySelectorAll('.global-header-control');
|
||
}
|
||
|
||
function saveGlobalHeaders() {
|
||
var payload = {};
|
||
getGlobalHeaderControls().forEach(function(control) {
|
||
var name = control.getAttribute('data-header-name');
|
||
if (!name) return;
|
||
payload[name] = control.value || '';
|
||
});
|
||
localStorage.setItem(HEADER_STORE_KEY, JSON.stringify(payload));
|
||
}
|
||
|
||
function loadGlobalHeaders() {
|
||
var raw = localStorage.getItem(HEADER_STORE_KEY) || '{}';
|
||
var data = {};
|
||
try {
|
||
data = JSON.parse(raw);
|
||
} catch (e) {
|
||
data = {};
|
||
}
|
||
|
||
getGlobalHeaderControls().forEach(function(control) {
|
||
var name = control.getAttribute('data-header-name');
|
||
if (!name) return;
|
||
if (Object.prototype.hasOwnProperty.call(data, name)) {
|
||
control.value = data[name] || '';
|
||
}
|
||
control.addEventListener('change', saveGlobalHeaders);
|
||
control.addEventListener('input', saveGlobalHeaders);
|
||
});
|
||
}
|
||
|
||
function collectGlobalHeaders() {
|
||
var headers = {};
|
||
var missingRequired = [];
|
||
|
||
getGlobalHeaderControls().forEach(function(control) {
|
||
var name = control.getAttribute('data-header-name');
|
||
var required = control.getAttribute('data-required') === 'true';
|
||
var value = (control.value || '').trim();
|
||
if (!name) return;
|
||
|
||
if (value) {
|
||
headers[name] = value;
|
||
} else if (required) {
|
||
missingRequired.push(name);
|
||
}
|
||
});
|
||
|
||
return {
|
||
headers: headers,
|
||
missingRequired: missingRequired,
|
||
};
|
||
}
|
||
|
||
function applySearch(keyword) {
|
||
var key = normalizeText(keyword).trim();
|
||
var cards = document.querySelectorAll('.method-card');
|
||
var groups = document.querySelectorAll('.group-block');
|
||
var navGroups = document.querySelectorAll('.nav-group');
|
||
var navItems = document.querySelectorAll('.nav-item');
|
||
var visibleCount = 0;
|
||
|
||
cards.forEach(function(card) {
|
||
var method = normalizeText(card.getAttribute('data-method'));
|
||
var desc = normalizeText(card.getAttribute('data-desc'));
|
||
var matched = !key || method.indexOf(key) >= 0 || desc.indexOf(key) >= 0;
|
||
card.style.display = matched ? '' : 'none';
|
||
if (matched) {
|
||
visibleCount += 1;
|
||
}
|
||
});
|
||
|
||
groups.forEach(function(group) {
|
||
var visibleCards = group.querySelectorAll('.method-card:not([style*="display: none"])').length;
|
||
group.style.display = visibleCards > 0 ? '' : 'none';
|
||
});
|
||
|
||
navItems.forEach(function(item) {
|
||
var method = normalizeText(item.getAttribute('data-method'));
|
||
var desc = normalizeText(item.getAttribute('data-desc'));
|
||
var matched = !key || method.indexOf(key) >= 0 || desc.indexOf(key) >= 0;
|
||
item.style.display = matched ? '' : 'none';
|
||
});
|
||
|
||
navGroups.forEach(function(group) {
|
||
var visibleItems = group.querySelectorAll('.nav-item:not([style*="display: none"])').length;
|
||
group.style.display = visibleItems > 0 ? '' : 'none';
|
||
if (key && visibleItems > 0) {
|
||
group.open = true;
|
||
}
|
||
});
|
||
|
||
if (searchStats) {
|
||
if (key) {
|
||
searchStats.textContent = '匹配 ' + visibleCount + ' / ${methodsCount} 个方法';
|
||
} else {
|
||
searchStats.textContent = '共 ${methodsCount} 个方法';
|
||
}
|
||
}
|
||
}
|
||
|
||
if (authInput) {
|
||
authInput.value = localStorage.getItem(AUTH_KEY) || '';
|
||
authInput.addEventListener('input', function() {
|
||
localStorage.setItem(AUTH_KEY, authInput.value.trim());
|
||
});
|
||
}
|
||
|
||
if (clearBtn) {
|
||
clearBtn.addEventListener('click', function() {
|
||
localStorage.removeItem(AUTH_KEY);
|
||
if (authInput) {
|
||
authInput.value = '';
|
||
}
|
||
});
|
||
}
|
||
|
||
loadGlobalHeaders();
|
||
|
||
if (searchInput) {
|
||
searchInput.addEventListener('input', function() {
|
||
applySearch(searchInput.value);
|
||
});
|
||
}
|
||
|
||
if (expandAllBtn) {
|
||
expandAllBtn.addEventListener('click', function() {
|
||
document.querySelectorAll('.nav-group').forEach(function(group) {
|
||
if (group.style.display !== 'none') {
|
||
group.open = true;
|
||
}
|
||
});
|
||
});
|
||
}
|
||
|
||
if (collapseAllBtn) {
|
||
collapseAllBtn.addEventListener('click', function() {
|
||
document.querySelectorAll('.nav-group').forEach(function(group) {
|
||
group.open = false;
|
||
});
|
||
});
|
||
}
|
||
|
||
document.addEventListener('click', async function(event) {
|
||
var btn = event.target.closest('.send-btn');
|
||
if (!btn) return;
|
||
|
||
var card = btn.closest('.method-card');
|
||
if (!card) return;
|
||
|
||
var queryInput = card.querySelector('.req-query');
|
||
var bodyInput = card.querySelector('.req-body');
|
||
var resultEl = card.querySelector('.req-result');
|
||
var endpoint = card.getAttribute('data-endpoint') || '/system';
|
||
var loginRequired = card.getAttribute('data-login-required') === 'true';
|
||
|
||
var query = (queryInput && queryInput.value.trim()) || '';
|
||
var url = query ? (endpoint + '?' + query) : endpoint;
|
||
var auth = (authInput && authInput.value.trim()) || localStorage.getItem(AUTH_KEY) || '';
|
||
var rawBody = (bodyInput && bodyInput.value.trim()) || '{}';
|
||
var globalHeaderData = collectGlobalHeaders();
|
||
|
||
var headers = {
|
||
'Content-Type': 'application/json',
|
||
};
|
||
Object.assign(headers, globalHeaderData.headers);
|
||
if (auth) {
|
||
headers.Authorization = auth;
|
||
}
|
||
|
||
if (globalHeaderData.missingRequired.length) {
|
||
if (resultEl) {
|
||
resultEl.textContent = '请求已阻止: 全局 Header 缺少必填项 -> ' + globalHeaderData.missingRequired.join(', ');
|
||
}
|
||
return;
|
||
}
|
||
|
||
var effectiveAuth = headers.Authorization || '';
|
||
|
||
if (loginRequired && !effectiveAuth) {
|
||
if (resultEl) {
|
||
resultEl.textContent = '请求已阻止: 当前接口 isNeedLogin=true,请先在页面顶部设置全局 Authorization。';
|
||
}
|
||
return;
|
||
}
|
||
|
||
btn.disabled = true;
|
||
if (resultEl) {
|
||
resultEl.textContent = '请求中...';
|
||
}
|
||
|
||
try {
|
||
var response = await fetch(url, {
|
||
method: 'POST',
|
||
headers: headers,
|
||
body: rawBody,
|
||
});
|
||
var text = await response.text();
|
||
var pretty = formatPretty(text);
|
||
if (resultEl) {
|
||
resultEl.textContent = 'HTTP ' + response.status + '\\n\\n' + pretty;
|
||
}
|
||
} catch (error) {
|
||
if (resultEl) {
|
||
resultEl.textContent = '请求失败: ' + error.message;
|
||
}
|
||
} finally {
|
||
btn.disabled = false;
|
||
}
|
||
});
|
||
|
||
initDefaultQueries();
|
||
applySearch('');
|
||
})();
|
||
</script>
|
||
</body>
|
||
</html>`;
|
||
}
|
||
|
||
class DocsController extends Controller {
|
||
async list() {
|
||
const { ctx } = this;
|
||
try {
|
||
const docs = await this.getDocNames();
|
||
if (!docs.length) {
|
||
ctx.status = 404;
|
||
ctx.body = {
|
||
code: 404,
|
||
message: 'methods 目录下没有可用的 JSON 文档',
|
||
};
|
||
return;
|
||
}
|
||
|
||
const fallback = docs.includes('system') ? 'system' : docs[0];
|
||
await this.renderDoc(fallback);
|
||
} catch (error) {
|
||
ctx.status = 500;
|
||
ctx.body = {
|
||
code: 500,
|
||
message: '读取文档失败',
|
||
error: error.message,
|
||
};
|
||
}
|
||
}
|
||
|
||
async api() {
|
||
await this.list();
|
||
}
|
||
|
||
async detail() {
|
||
const { ctx } = this;
|
||
const docName = ctx.params.docName;
|
||
await this.renderDoc(docName);
|
||
}
|
||
|
||
async raw() {
|
||
const { ctx } = this;
|
||
const docName = ctx.params.docName;
|
||
|
||
if (!/^[a-zA-Z0-9_-]+$/.test(docName || '')) {
|
||
ctx.status = 400;
|
||
ctx.body = { code: 400, message: '无效文档名' };
|
||
return;
|
||
}
|
||
|
||
const filePath = path.join(this.app.baseDir, 'methods', `${docName}.json`);
|
||
|
||
try {
|
||
const content = await fs.readFile(filePath, 'utf8');
|
||
ctx.type = 'application/json; charset=utf-8';
|
||
ctx.body = content;
|
||
} catch (error) {
|
||
ctx.status = 404;
|
||
ctx.body = {
|
||
code: 404,
|
||
message: `未找到文档: ${docName}`,
|
||
};
|
||
}
|
||
}
|
||
|
||
async getDocNames() {
|
||
const docsDir = path.join(this.app.baseDir, 'methods');
|
||
const entries = await fs.readdir(docsDir, { withFileTypes: true });
|
||
|
||
return entries
|
||
.filter(entry => entry.isFile() && entry.name.endsWith('.json'))
|
||
.map(entry => entry.name.replace(/\.json$/i, ''))
|
||
.sort();
|
||
}
|
||
|
||
async renderDoc(docName) {
|
||
const { ctx, app } = this;
|
||
|
||
if (!/^[a-zA-Z0-9_-]+$/.test(docName || '')) {
|
||
ctx.status = 400;
|
||
ctx.body = { code: 400, message: '无效文档名' };
|
||
return;
|
||
}
|
||
|
||
const filePath = path.join(app.baseDir, 'methods', `${docName}.json`);
|
||
|
||
try {
|
||
const [ content, docs ] = await Promise.all([
|
||
fs.readFile(filePath, 'utf8'),
|
||
this.getDocNames(),
|
||
]);
|
||
|
||
const docData = JSON.parse(content);
|
||
const groups = normalizeGroups(docData);
|
||
const entryPath = docData.module === 'qimen'
|
||
? '/qimen'
|
||
: (docData.module === 'gateway' ? '/internal/v1/gateway' : '/system');
|
||
const html = renderHtmlPage({
|
||
docName,
|
||
docData,
|
||
groups,
|
||
docs,
|
||
entryPath,
|
||
});
|
||
|
||
ctx.type = 'text/html; charset=utf-8';
|
||
ctx.body = html;
|
||
} catch (error) {
|
||
ctx.status = 404;
|
||
ctx.body = {
|
||
code: 404,
|
||
message: `未找到文档或 JSON 格式错误: ${docName}`,
|
||
error: error.message,
|
||
};
|
||
}
|
||
}
|
||
}
|
||
|
||
module.exports = DocsController;
|