📝 操作步骤
- 1选中 API 路由文件或控制器代码
- 2使用 Cursor 的 Chat 功能
- 3输入提示词要求生成文档
- 4AI 会分析接口参数、返回值、错误码等
- 5复制生成的 Markdown 文档
- 6添加到项目的 docs 目录
💡 示例提示词
请为这些 API 接口生成详细的文档,包括:请求方法、URL、参数说明、返回格式、示例代码、错误码说明。使用 Markdown 格式,适合放在项目 README 中。
请为这些 API 接口生成详细的文档,包括:请求方法、URL、参数说明、返回格式、示例代码、错误码说明。使用 Markdown 格式,适合放在项目 README 中。