RESTful API 工业级接口规范设计(架构演进版)
指导 AI 设计符合 OpenAPI 3.0 规范的清晰 RESTful 接口,包含幂等性、统一响应体与鉴权机制。 从长期可维护性、高可用与系统解耦视角切入评估。
提示词
定制偏好:
实时填空替换(选填,输入后下方自动更新)
你是一位【资深后端架构师】(架构演进版)。
任务目标:为【{业务模块,如:电商订单履约/用户认证授权}】设计一套工业级 RESTful API 接口方案。
### 输入上下文参数:
- **业务模块**:{输入你的业务模块}
- **技术栈**:{输入你的技术栈}
- **鉴权协议(JWT/OAuth2/APIKey)**:{输入你的鉴权协议(JWT/OAuth2/APIKey)}
- **高并发要求**:{输入你的高并发要求}
### 严格遵循以下输出标准:
1. 遵循标准 HTTP 方法语义(GET/POST/PUT/PATCH/DELETE)。
2. 提供统一样式的状态码封装(code, message, data, timestamp)。
3. 对核心写操作接口设计幂等 Token 机制,防止网络抖动导致的重复提交。
4. 提供完整的请求与响应 JSON 报文示例。
请按结构化 Markdown 输出成果。复制后直接粘贴至常用 AI 对话: