{ "docName": "example", "newDoc": { "module": "example", "description": "示例文档(由 docs/api-doc-update-spec.example.json 复制而来,正式使用时请按需修改 docName/newDoc/group/methods/change)", "http": { "path": "/example", "method": "POST" }, "headers": [ { "name": "Content-Type", "type": "string", "required": true, "description": "application/json" } ] }, "docMeta": { "version": "0.1.0", "updatedAt": "2026-09-12" }, "group": { "groupName": "示例分组", "module": "example" }, "methods": [ { "method": "example.ping", "description": "示例方法:演示固定 spec 的最小结构。", "isNeedAuth": true, "isNeedLogin": false, "headers": [], "params": [ { "name": "name", "type": "string", "required": true, "source": "query", "description": "示例入参" } ], "response": [ { "name": "ok", "type": "boolean", "required": true, "description": "是否成功" } ], "errors": [ { "code": 400, "message": "参数错误" } ], "notes": [ "params 允许 source(query/body);headers/response 不写 source;response 项必须含 boolean 的 required" ] } ], "deleteMethods": [], "change": { "version": "2026.09.12-example-init", "date": "2026-09-12", "type": "added", "summary": "示例变更记录。", "methods": [ "example.ping" ], "notes": [ "正式使用时请替换为真实的 version/summary/methods/notes,并确保 version 不重复" ] } }