JSON API:用JSON构建API的标准指南中文版

github地址:https://github.com/justjavac/json-api-zh_CN

如果你和你的团队曾经争论过使用什么方式构建合理 JSON 响应格式, 那么 JSON API 就是你的 anti-bikeshedding 武器。

通过遵循共同的约定,可以提高开发效率,利用更普遍的工具,可以是你更加专注于开发重点:你的程序。

基于 JSON API 的客户端还能够充分利用缓存,以提升性能,有时甚至可以完全不需要网络请求。

下面是一个使用 JSON API 发送响应(response)的示例:

  1.   "links": { 
  2.     "posts.author": { 
  3.       "href": "http://example.com/people/{posts.author}", 
  4.       "type": "people" 
  5.     }, 
  6.     "posts.comments": { 
  7.       "href": "http://example.com/comments/{posts.comments}", 
  8.       "type": "comments" 
  9.     } 
  10.   }, 
  11.   "posts": [{ 
  12.     "id": "1", 
  13.     "title": "Rails is Omakase", 
  14.     "links": { 
  15.       "author": "9", 
  16.       "comments": [ "5", "12", "17", "20" ] 
  17.     } 
  18.   }] 

顶级的 "links" 部分是可选的。 除去 "links" 部分,此响应看起来非常接近使用已经存在的 API 构建的响应。

JSON API 不仅可以用来构建响应,还包括创建和更新资源。

现状

本文档是一个正在进展的工作,在具体实现过程中将会有所改变。详细信息请查看现状页面。

MIME 类型

JSON API 已经在 IANA 机构完成注册。 它的 MIME 类型是 application/vnd.api+json

格式

在开始使用 JSON API 前,先查看一下JSON API 格式文档

更新历史

  • 2013-05-03:最初版本的草案。
  • 2013-07-22:媒体类型在 IANA 注册完成。

转载请注明:代码家园 » JSON API:用JSON构建API的标准指南中文版

评论列表(网友评论仅供网友表达个人看法,并不表明本站同意其观点或证实其描述)