你们的 API 设计符合规范吗？来看看这份一万多颗星的API设计指南

你们的 API 设计符合规范吗？

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

https://github.com/interagent/http-api-design

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

你们的 API 设计有哪些问题？

其中，API 的团队合作可以采用 Apifox²、Postman 等 API 团队协作工具，方便调试、测试及更好的文档协作。

https://www.apifox.cn/?utm_source=shanyue-question

参考资料

[1]

http-api-design:https://github.com/interagent/http-api-design

[2]

Apifox:https://www.apifox.cn/?utm_source=shanyue-question

vlambda博客
学习文章列表