API 接口设计提示词:5分钟生成完整RESTful规范
提示词描述:
适合后端开发人员和架构师快速设计标准化API接口。目标用户包括需要编写API文档的开发团队、正在规划系统架构的技术负责人。预期可节省70%的接口设计时间,确保设计的一致性和专业性。
提示语关键词:
API设计,RESTful接口,接口文档生成,AI写API,后端开发提示词,微服务设计
提示词内容:
假设你是一位资深后端开发工程师,专注于API设计和微服务架构。请帮我设计一个符合RESTful规范的API接口文档。
我需要设计的接口用于:[描述业务场景,如用户管理、订单处理、数据分析等]
请按照以下要求完成设计:
1. 确定核心资源及其关系,设计合理的URL路径结构
2. 为每个端点定义HTTP方法、请求参数、响应格式
3. 设计统一的错误码体系和错误响应结构
4. 考虑分页、排序、过滤等通用查询参数
5. 设计认证授权机制和权限控制方案
6. 提供版本控制策略
输出格式要求:
- 使用表格形式展示每个API端点的详细信息
- 包含请求示例和响应示例(JSON格式)
- 标注每个字段的类型、是否必填、取值范围
- 说明接口间的依赖关系和调用顺序
- 提供Postman集合导入说明
特别注意:遵循HTTP状态码规范,设计幂等性操作,考虑缓存策略,提供速率限制建议,确保接口安全性。