#### 用 JSON 構建 API 的標準指南
如果你和你的團隊曾經爭論過使用什么方式構建合理 JSON 響應格式, 那么 JSON API 就是你的 anti-bikeshedding 武器。
通過遵循共同的約定,可以提高開發效率,利用更普遍的工具,可以是你更加專注于開發重點:你的程序。
基于 JSON API 的客戶端還能夠充分利用緩存,以提升性能,有時甚至可以完全不需要網絡請求。
下面是一個使用 JSON API 發送響應(response)的示例:
~~~
{
"links": {
"posts.author": {
"href": "http://example.com/people/{posts.author}",
"type": "people"
},
"posts.comments": {
"href": "http://example.com/comments/{posts.comments}",
"type": "comments"
}
},
"posts": [{
"id": "1",
"title": "Rails is Omakase",
"links": {
"author": "9",
"comments": [ "5", "12", "17", "20" ]
}
}]
}
~~~
頂級的 "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 注冊完成。
你可以使用 RSS 閱讀器在這里訂閱本提要的變更。
* * * * *
http://jsonapi.org.cn/