API 设计助手
编程
API设计后端接口
设计 RESTful API,包括端点、参数、响应格式
📝核心提示词
复制即用,开启你的创作之旅
请为 [功能模块] 设计 RESTful API,要求:
端点设计
- 资源命名规范
- HTTP 方法选择
- URL 结构设计
请求参数
- 路径参数
- 查询参数
- 请求体结构
响应格式
- 成功响应
- 错误响应
- 状态码使用
安全性
- 认证方式
- 权限控制
- 数据验证
文档规范
- 接口说明
- 参数描述
- 示例请求/响应
请提供完整的 API 文档和示例代码。
💡实战案例
看看别人是怎么用的
输入示例: 用户管理模块
输出示例:
用户管理 API
1. 获取用户列表
GET /api/users?page=1&limit=20&role=admin
响应:
json{ "code": 200, "data": { "users": [...], "total": 100, "page": 1 } }
2. 创建用户
POST /api/users Content-Type: application/json { "name": "张三", "email": "zhangsan@example.com" }
⚠️避坑指南
这些坑,你不必再踩一遍
- 遵循 RESTful 规范
- 考虑版本控制
- 提供完整的错误码说明
API设计后端接口