Expose plain-text API documentation with agent_mode

2026-10-26 14:59:54 +08:00
parent b0a60ea498
commit f81aed8ce8
20 changed files with 228 additions and 5 deletions
@@ -0,0 +1,11 @@
+import type {NextApiRequest,NextApiResponse} from 'next';
+const docs:Record<string,string>={
+ '/studio/api/export/{slug}': '# 导出创作方案\n\n方法：GET\n路径参数：slug，创作方案的稳定标识。\n查询参数：format=markdown 返回 Markdown；其他值或省略时返回带 version:1 的方案 JSON，带附件文件名。\n示例：GET /studio/api/export/{slug}\n错误：404 方案不存在；405 方法不支持。',
+ '/studio/api/health': '# 创作站健康检查\n\n方法：GET, HEAD\n无业务参数。GET 返回 200 JSON：{"status":"ok","service":"prompt-studio"}；HEAD 无正文。\n示例：GET /studio/api/health\n错误：405 方法不支持。',
+};
+export function serveApiDocumentation(req:NextApiRequest,res:NextApiResponse,path:string){
+ if(!['GET','HEAD'].includes(req.method||'')||typeof req.query.agent_mode!=='string'||req.query.agent_mode.toLowerCase()!=='true')return false;
+ if(!docs[path])return false;
+ res.setHeader('Content-Type','text/plain; charset=utf-8');res.setHeader('Cache-Control','no-store');res.status(200);
+ if(req.method==='HEAD')res.end();else res.send(docs[path]+'\n\n使用 GET 或 HEAD，在原地址加 ?agent_mode=True；已有参数时加 &agent_mode=True。值不区分大小写。动态路径可保留占位符读取说明。业务调用请移除 agent_mode。\nAPI 目录：/api?agent_mode=True\n');return true;
+}