API接口文档生成
接口写完不想手写文档时用这条：把后端路由或处理函数交给 Agent，它会梳理路径、参数、响应、安全认证和错误码，生成符合 OpenAPI 规范的文档，并给出 Swagger 在线预览地址。
适合做什么
- 在 Cursor / 同类 Agent 里挂载可复用技能
- 把重复检查或生成流程固化成一句话指令
- 团队共享「技能卡」减少口头约定
不太适合
- 当作完整安全审计或生产发布的唯一依据
- 无环境上下文时指望一次跑通复杂流水线
提示词正文
【技能名称】API接口文档生成
【技能目标】分析后端路由/handler代码，自动生成OpenAPI 3.0文档：路径/参数/响应/安全认证/错误码，附Swagger UI在线预览地址。
【使用方式】
1. 将上方目标作为 Agent Skill / 自定义指令的核心描述；
2. 补充你的项目路径、技术栈与验收标准；
3. 要求 Agent 先列出检查清单，再执行并给出可复核的输出（如 diff / 报告）；
4. 若涉及发布或删除，必须二次确认。
【运营向用法提示】
可用于内容站、工具站或增长落地页的自动化检查与批处理；输出请要求中文结论 + 可执行下一步。复制后粘贴到 AI 对话框，按填空补全即可。
使用步骤
- 把路由或handler所在目录写进技能描述
- 说明认证方式、错误码规范和输出格式
- 先核对接口清单，再让它生成OpenAPI文件
常见问题
接口注释很少也能生成吗？
能生成骨架，但参数含义和必填项会靠推测。建议在技能描述里补上参数来源是路径、查询还是请求体，并给出示例值，生成后再逐条核对。
文档和代码不一致怎么办？
让它先输出路由清单与实际文件路径的对应表，确认覆盖范围后再生成文档；后续改动代码时重新跑一次，避免手工维护两份。
Swagger预览地址哪来？
这一步由你在本地或测试环境启动，把项目里的静态资源路径或部署地址补进技能描述；模型只负责输出OpenAPI文件内容，不负责托管。
来源说明
整理自公开提示词站点素材，经 52运营 筛选与页面改写，便于运营场景检索。 原始参考：来源链接