在 Github 上,有一个仓库名为 http-api-design,列出了一份 API 设计指南的清单,比如有一些内容,你们有可能不是最佳实践:

  1. 为自省提供请求 ID。在每个 API 响应中包含一个 Request-Id 标头,填充一个 UUID 值。 通过在客户端、服务器和任何支持服务上记录这些值,它提供了一种跟踪、诊断和调试请求的机制。
  2. 返回适当的状态代码。比如 422、429 等
  3. 使用 ISO8601 格式的 UTC 时间
  4. 提供可读性强的文档

作者 meiyoufan

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注