【文件属性】:
文件名称:api-playbook:定义用于构建API的约定的地方
文件大小:4KB
文件格式:ZIP
更新时间:2021-05-31 07:56:52
API 风格指南
定义用于构建API的约定的地方
在可用的情况下提供完整的资源
提供标准时间戳
使用 ISO8601 格式的 UTC 时间
嵌套外键关系
生成结构化错误
显示速率限制状态
在所有响应中保持 JSON 缩小
基本工具
在 Hyper 中使用Ruby on Rails构建 API 是很常见的,因此这些约定中的大多数都旨在与 Rails 配合使用。
本土化
当需要本地化响应时,建议客户端发送Accept-Language标头:
Accept-Language: nb-no, no, en
Heroku约定
我们考虑了Heroku 构建 API 的大部分约定。
基金会
单独的关注点
通过分离请求和响应周期的不同部分之间的关注点,在设计时保持简单。 在这里保持简单的规则可以让更多的注意力集中在更大和更难的问题上。
将提出请求和响应以解决特定资源或集合。 使用路径来
【文件预览】:
api-playbook-master
----README.md(10KB)