统一接口 🌐
- 使用一致的端点命名规则(如
/users
而非/user_list
) - 遵循标准的 HTTP 方法(GET/POST/PUT/DELETE)
- 保持响应格式标准化(如 JSON 或 XML)
- 使用一致的端点命名规则(如
无状态通信 🔄
- 服务器不存储客户端会话信息
- 每次请求需包含完整认证信息(如 Token)
- 通过 URL 参数或请求头传递状态
安全性 🔒
- 强制 HTTPS 协议加密传输
- 使用 OAuth2 或 JWT 实现权限控制
- 对敏感字段进行脱敏处理(如
user_id
而非real_name
)
可扩展性 🌱
- 设计时预留版本控制(如
/v1/resource
) - 避免过度耦合,使用模块化架构
- 支持异步处理与负载均衡
- 设计时预留版本控制(如
错误处理 ❗
- 返回统一错误格式(如
{"error": "描述", "code": 404}
) - 区分客户端错误与服务器错误
- 提供详细的日志追踪 ID 供排查
- 返回统一错误格式(如