25 lines
2.9 KiB
TypeScript
25 lines
2.9 KiB
TypeScript
import type {NextApiRequest,NextApiResponse} from 'next';
|
||
const docs:Record<string,string>={
|
||
'/studio/api/export/{slug}': `# Studio 封面工具 API
|
||
|
||
方法：GET, POST
|
||
路径参数：slug 为 learning-skills-template（同一母版四张试版）或 layout-selection（三种不同构图）；first-idea 仅提供 GET 内容导出。
|
||
GET 参数：省略 format 返回方案 JSON；format=markdown 返回说明；format=svg 返回初始封面。四张试版用 slide=0..3（默认 0），多模板工具用 layoutId=ref-01|ref-07|ref-26（默认 ref-01）。
|
||
JSON：普通方案 version:1；四张试版 version:2；多模板 version:3，layouts 包含源教程、画板、构件坐标及分层蒙版。文字、图位、装饰一一对应，图片位为色块占位。
|
||
POST：Content-Type: application/json。format=svg（默认）返回独立 SVG；format=json 返回渲染参数及模板信息。请求最大 32KB，无存储副作用。
|
||
learning-skills-template 参数：slide（整数 0–3，默认 0）、heading（1–6 字）、body（最多 360 字、3 行）、color、accent（#RRGGBB）、masthead（2 项数组，每项 1–8 个英文字母/空格）；省略参数沿用初始值。
|
||
layout-selection 参数：layoutId（必填，ref-01/ref-07/ref-26）、fields（可选，以对应模板 T 构件 ID 为键；每项 1–120 字、最多 4 行）、color、accent（#RRGGBB）。省略文字沿用初始值；拒绝未知参数或构件 ID。
|
||
示例：POST /studio/api/export/learning-skills-template?format=svg
|
||
{"slide":1,"heading":"笔记复习","color":"#7a8b7e"}
|
||
POST /studio/api/export/layout-selection?format=svg
|
||
{"layoutId":"ref-01","fields":{"T01":"STUDY","T02":"笔记复习\\n主题说明占位"},"color":"#83918a"}
|
||
错误：400 参数/格式错误；404 方案不存在；405 方法不支持；413 请求过大。SVG 不含编辑辅助边界，文字经过 XML 转义；装饰位分层图片是按源构件重建的矢量；原始低分辨率分层保留在模板 JSON 中供核对。`,
|
||
'/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;
|
||
}
|