jsonapi-for-terrans:人族的 JSON API(提案)

时间:2024-08-11 06:02:23
【文件属性】:

文件名称:jsonapi-for-terrans:人族的 JSON API(提案)

文件大小:3KB

文件格式:ZIP

更新时间:2024-08-11 06:02:23

人族的 JSON API 动机 有很多 REST API 实现。 决定使用什么总是需要很多时间。 例如,我们应该使用 unix time 还是 ISO8601? 外键应该如何处理? 如何返回错误? 等等。 本文档仅描述了在生产中运行良好的实践。 REST API 应该直观易懂,无需阅读大量文档。 几年前我们开始使用 jsonapi.org 但它相当不稳定,每次我访问 jsonapi.org 时我都知道以前写的所有内容都与新版本不兼容。 此外,jsonapi.org 变得过于复杂。 我们称它为虫族的 jsonapi。 在我们公司,我们更喜欢对人族使用 jsonapi :)。 本文档对其进行了描述。 一切都写在文档中只是推荐,没有“必须”,对边缘情况使用常识。 通用规则 所有路由都应以 /api/v1 为前缀。 资源名称的复数形式。 例如,“用户”、“订单”、“帖子”等。 camelC


【文件预览】:
jsonapi-for-terrans-master
----README.md(8KB)

网友评论