WMS_MAIN/script/method-doc-export.cjs

74 lines
2.6 KiB
JavaScript
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.

'use strict';
/**
* 从库表重建 methods/system.json(原子写入,docs 页面仍读该文件)。
*
* 用法:
* node script/method-doc-export.cjs [--env production] [--doc system] [--file methods/system.json]
*/
const fs = require('node:fs');
const {
resolveEnv, createConnection, parseArgs, parseJsonColumn, formatDate, fail,
} = require('./method-doc-common.cjs');
(async () => {
const args = parseArgs();
const env = resolveEnv();
const docName = args.get('doc') || 'system';
const file = args.get('file') || `methods/${docName}.json`;
const conn = await createConnection(env);
const [ metaRows ] = await conn.query(
'SELECT * FROM wms_method_doc_meta WHERE doc_name=? ORDER BY id ASC LIMIT 1',
[ docName ]
);
const [ rows ] = await conn.query(
'SELECT * FROM wms_api_method_doc WHERE status=1 ORDER BY group_sort ASC, item_sort ASC, id ASC'
);
await conn.end();
const meta = metaRows[0];
// 按 (group_sort, module, group_name) 重建分组
const groups = [];
const groupIndex = new Map();
for (const row of rows) {
const key = `${row.group_sort}\u0000${row.module}\u0000${row.group_name}`;
let group = groupIndex.get(key);
if (!group) {
group = { groupName: row.group_name || '', module: row.module || '', list: [] };
groupIndex.set(key, group);
groups.push(group);
}
// 优先用 payload 原文(含 status/notes/requestBody 等扩展字段,无损往返);
// 无 payload(老数据/脚本创建未带)时按结构化列组装
const parsedPayload = row.payload ? parseJsonColumn(row.payload) : null;
group.list.push(parsedPayload || {
method: row.method,
description: row.description || '',
isNeedAuth: !!row.is_need_auth,
isNeedLogin: !!row.is_need_login,
headers: parseJsonColumn(row.headers) || [],
params: parseJsonColumn(row.params) || [],
response: parseJsonColumn(row.response) || [],
errors: parseJsonColumn(row.errors) || [],
});
}
const doc = {
module: (meta && meta.module) || docName,
description: (meta && meta.description) || '',
version: (meta && meta.version) || '0.3.0',
updatedAt: meta ? formatDate(meta.updated_at) : new Date().toISOString().slice(0, 10),
headers: parseJsonColumn(meta && meta.headers) || [],
methods: { groups },
};
const tmp = `${file}.tmp`;
fs.writeFileSync(tmp, JSON.stringify(doc, null, 4) + '\n', 'utf8');
fs.renameSync(tmp, file);
console.log(`[method-doc] 导出完成:file=${file} version=${doc.version} updatedAt=${doc.updatedAt} groups=${groups.length} methods=${rows.length}(env=${env})`);
})().catch(e => fail(e.message));