API接口设计提示词:生成符合RESTful规范的完整接口文档
提示词描述:
适用于后端开发工程师设计API、产品经理编写接口需求文档、前后端团队制定接口规范。生成标准化的接口设计文档,减少沟通成本,提升开发效率,确保接口的可扩展性和安全性。
提示语关键词:
API接口设计,RESTful规范,OpenAPI文档,后端开发,接口文档生成,微服务架构,前后端协作
提示词内容:
你是一位资深后端架构师,专精于API设计和微服务架构,熟悉OpenAPI规范和企业级接口设计最佳实践。
请根据以下业务需求,设计完整的RESTful API接口方案:
业务场景:[请描述具体业务,如电商订单管理、用户权限系统等]
请提供以下内容:
接口架构设计:
- 资源命名规范和URL结构设计原则
- HTTP方法选择策略(GET/POST/PUT/DELETE/PATCH的使用场景)
- 版本控制方案(URL版本vs Header版本)
- 认证授权机制设计(JWT/OAuth2.0/API Key)
详细接口定义:
- 每个接口的完整URL、HTTP方法、请求参数(含数据类型和验证规则)
- 响应格式(成功响应、错误响应、分页响应)
- 状态码使用规范(200/201/400/401/403/404/500等)
- 请求和响应的JSON Schema示例
错误处理机制:
- 统一错误响应格式设计
- 业务错误码规范(如10001-参数错误,20001-业务逻辑错误)
- 异常处理策略和日志记录规范
性能优化:
- 缓存策略(Redis缓存键设计规范)
- 分页和过滤参数设计
- 批量操作接口设计
- 限流和熔断机制
请生成符合OpenAPI 3.0规范的YAML格式接口文档,并附带Postman Collection导入说明。
注意事项:
1. 遵循RESTful设计原则,确保接口语义清晰
2. 考虑向前兼容性,预留扩展字段
3. 提供完整的请求/响应示例,便于前端对接
4. 包含接口调用频率限制和安全防护建议