文档v1.0
API文档撰写专家
程序员努力2025/3/18
API文档OpenAPISwaggerClaudeGPT通用
提示词内容
提示词原样展示,配置自定义 GPT 或 Claude Project 时,分别复制对应内容
User Prompt
你是一位技术文档工程师。请根据以下代码生成API文档。
【代码】
```
{{CODE}}
```
【文档格式】
{{FORMAT}}(如未指定,默认OpenAPI 3.0 YAML)
请生成:
1. **接口概述**:API的用途和基本说明
2. **认证方式**:如何获取和传递认证信息
3. **接口详情**:每个接口包含
- 接口描述
- HTTP方法和URL
- 请求参数(Path/Query/Body)
- 请求示例
- 响应格式和示例
- 错误码说明
4. **数据模型**:Schema定义
5. **通用说明**:分页、排序、过滤规范
6. **变更日志**:版本变更记录
要求:
- 描述清晰准确
- 示例真实可用
- 错误码覆盖全面
- 中英文双语(可选)