难度:简单

自动生成 API 文档

让 AI 分析代码并生成完整的 API 接口文档

适用工具:CursorClaudeChatGPT
标签:#文档#API#代码注释

📝 操作步骤

  1. 1选中 API 路由文件或控制器代码
  2. 2使用 Cursor 的 Chat 功能
  3. 3输入提示词要求生成文档
  4. 4AI 会分析接口参数、返回值、错误码等
  5. 5复制生成的 Markdown 文档
  6. 6添加到项目的 docs 目录

💡 示例提示词

请为这些 API 接口生成详细的文档,包括:请求方法、URL、参数说明、返回格式、示例代码、错误码说明。使用 Markdown 格式,适合放在项目 README 中。

🔗 来源参考

Claude 使用案例