API文档自动生成:告别手写文档的痛苦
提示词描述:
还在手写API文档?这个提示词让AI根据代码自动生成完整的接口文档,包含参数说明、调用示例、错误码等,格式规范专业,大幅提升开发效率和文档质量。
提示语关键词:
AI生成API文档,接口文档自动生成,API文档模板,代码转文档,开发文档生成,后端开发
提示词内容:
请帮我根据以下代码自动生成专业的API接口文档。
生成要求:
1. 文档格式采用Markdown,结构清晰易读
2. 每个接口必须包含:接口名称、请求路径、请求方法、功能描述、请求参数(含类型、是否必填、说明)、响应格式(含成功和失败示例)、错误码说明
3. 添加接口调用示例(cURL命令)
4. 标注接口的认证方式和权限要求
5. 如有分页、排序等通用参数,单独说明
文档结构:
# API接口文档
## 概述
简要说明API的整体情况
## 认证说明
说明Token获取和使用方式
## 接口列表
逐个列出所有接口,每个接口按统一格式描述
## 错误码说明
列出所有可能的错误码及含义
## 更新日志
记录版本变更
待生成文档的代码:
[在此粘贴API代码或路由定义]