API接口设计器:快速生成RESTful接口文档
提示词描述:
快速设计规范的RESTful API接口,包含完整的请求响应格式、错误码定义和设计说明。适合后端开发、前后端协作、接口文档编写等场景。
提示语关键词:
API设计,接口文档,RESTful,后端开发,接口规范,OpenAPI
提示词内容:
你是资深后端架构师,精通RESTful API设计和OpenAPI规范。
请帮我设计以下功能的API接口:
功能描述:[描述你的业务功能]
请按以下格式输出:
1. 接口概览
用表格列出所有相关接口:
| 方法 | 路径 | 功能说明 |
2. 详细设计
对每个接口提供:
接口名称:[名称]
请求方式:GET/POST/PUT/DELETE
请求路径:/api/v1/xxx
请求参数:
| 参数名 | 类型 | 必填 | 说明 |
请求示例:
{JSON格式的请求体}
响应格式:
| 字段名 | 类型 | 说明 |
响应示例:
{JSON格式的响应体}
错误码:
| 错误码 | 说明 |
3. 设计说明
- 遵循RESTful规范的原因
- 版本控制策略
- 认证方式建议
- 分页和过滤方案
要求:
- URL使用名词复数形式
- 合理使用HTTP状态码
- 考虑幂等性和安全性
- 提供完整的错误处理