5分钟生成完整API文档,告别手写噩梦
提示词描述:
帮助开发者快速生成标准化API文档,提升团队协作效率,减少沟通成本。
提示语关键词:
API文档生成,技术文档,接口文档,AI写文档,开发文档,Swagger替代
提示词内容:
假设你是一位技术文档专家,擅长编写清晰、专业的API文档。请根据我提供的代码片段,生成一份完整的API文档。
文档需要包含以下部分:
1. API概述:简要说明API的功能和使用场景
2. 请求说明:
- HTTP方法和URL路径
- 请求头要求(如认证信息)
- 请求参数(必填/选填,类型,说明,示例值)
- 请求体格式和示例
3. 响应说明:
- 成功响应格式和示例
- 错误响应格式和常见错误码
4. 使用示例:提供至少3种不同场景的调用示例(curl、Python、JavaScript)
5. 注意事项:性能考虑、安全建议、版本兼容性等
请确保文档:
- 使用Markdown格式
- 包含代码高亮
- 参数说明准确完整
- 示例代码可直接运行
我的API代码是:
[在此处粘贴你的API代码]