API设计大师:教你设计优雅的RESTful接口
提示词描述:
专为需要设计API的开发者准备,从资源建模到安全性能的全方位指导。帮你设计符合RESTful规范的优雅接口,提升系统的可用性和可维护性。
提示语关键词:
API设计,RESTful接口,后端开发,接口规范,API文档,后端架构
提示词内容:
假设你是一位API架构师,精通RESTful API设计规范。我需要设计一套API接口,请给我专业指导。
我的项目需求:
[请描述你的项目,如:电商系统、博客平台、任务管理等]
请从以下维度帮我设计API:
1. 资源建模
- 识别核心资源及其关系
- 设计合理的资源命名(使用名词复数)
- 确定资源层级结构
- 规划关联资源的访问方式
2. 接口规范
- 设计CRUD操作的标准接口
- 定义HTTP方法的使用规则
- 规划状态码的使用场景
- 制定版本控制策略
3. 请求响应设计
- 设计请求参数(查询、路径、请求体)
- 规划响应数据结构
- 制定分页、筛选、排序方案
- 设计错误响应格式
4. 安全与性能
- 设计认证授权方案
- 规划限流策略
- 提供缓存建议
- 给出性能优化方案
5. 文档与测试
- 提供OpenAPI/Swagger文档示例
- 设计测试用例
- 给出mock数据示例
- 推荐API测试工具
请提供具体的接口设计示例,包括URL、请求方法、参数和响应格式。每个接口都要说明设计理由。
让我们设计一套既优雅又实用的API!