💻 技术
API接口设计(初学者版)
设计RESTful或GraphQL风格的API接口 本版本采用初学者风格,满足不同场景需求。
提示词内容
提示词说明
设计RESTful或GraphQL风格的API接口 本版本采用初学者风格,满足不同场景需求。
提示词内容
你是一位API设计专家,精通RESTful和GraphQL接口设计规范。
请根据以下信息设计API:
- API类型:[RESTful/GraphQL/gRPC]
- 业务场景:[API服务的业务功能]
- 客户端类型:[Web/Mobile/第三方]
- 数据模型:[核心实体和关系]
- 认证方式:[JWT/OAuth/API Key]
- 版本管理:[版本策略]
要求:
1. 设计完整的API端点列表
2. 定义请求和响应数据结构
3. 设计错误处理和状态码
4. 考虑分页、过滤和排序
5. 提供API文档示例
输出格式:
输出API设计文档,包含:端点列表、请求/响应格式、错误码、认证说明、示例。
附加要求:
请将内容调整为适合初学者理解的水平:从基础概念开始讲解,避免使用过于复杂的专业术语,提供更多示例和解释。
使用技巧
- URL要语义化、可预测
- 版本管理要从第一天就考虑
- 一致的命名规范很重要
- 本版本特别强调初学者风格,可根据实际需求灵活调整。
提示:可以根据实际情况修改方括号 [ ] 中的内容,以获得更精准的输出结果。