首页提示词库API 接口设计
💻 编程开发适用:ChatGPT, Claude

API 接口设计

从零开始设计规范的 RESTful API 接口

API后端设计
分享:
提示词内容
请帮我设计{类型} API 接口。

业务场景:{描述业务场景}
实体/资源:{核心实体}

请提供:

1. RESTful 路由设计
   - 列出所有端点及 HTTP 方法
   - 请求/响应格式(JSON Schema)

2. 关键接口详细设计
   - 参数说明
   - 响应示例
   - 错误码定义

3. 数据模型设计
   - 核心字段
   - 关系说明

4. 安全考虑
   - 认证方式
   - 权限控制
   - 频率限制

5. 建议补充
   - 分页/排序/筛选
   - 缓存策略
   - 版本管理

使用技巧

说明是内部 API 还是开放 API,会影响安全策略和版本管理方案