在线观看不卡亚洲电影_亚洲妓女99综合网_91青青青亚洲娱乐在线观看_日韩无码高清综合久久

鍍金池/ 教程/ Linux/ 良好打印的默認(rèn) JSON
良好打印的默認(rèn) JSON
強(qiáng)制使用安全連接(Secure Connections)
通過(guò)請(qǐng)求中的范圍(Range)拆分大的響應(yīng)
嵌套外鍵關(guān)系
支持方便的無(wú) id 間接引用
使用 UTC(世界標(biāo)準(zhǔn)時(shí)間)時(shí)間,用 ISO8601 進(jìn)行格式化
提供標(biāo)準(zhǔn)的時(shí)間戳
提供資源的(UU)ID
提供全部可用的資源
描述穩(wěn)定性
路徑和屬性要小寫(xiě)
強(qiáng)制頭信息 Accept 中提供版本號(hào)
生成結(jié)構(gòu)化的錯(cuò)誤
使用統(tǒng)一的資源路徑格式
支持 Etag 緩存
保證響應(yīng) JSON 最小化
在請(qǐng)求的 body 體使用 JSON 格式數(shù)據(jù)
隔離關(guān)注點(diǎn)
顯示頻率限制狀態(tài)
提供可執(zhí)行的例子
返回合適的狀態(tài)碼
最小化路徑嵌套
可讀性
為內(nèi)省而提供 Request-Id

良好打印的默認(rèn) JSON

用戶第一次查看你的 API 很可能是在使用 curl 的命令行里。如果 API 的響應(yīng)有良好的打印格式,那在命令行里它們會(huì)很容易理解。為了給這些開(kāi)發(fā)者提供方便,良好打印格式的 JSON 如下:

{
  "beta": false,
  "email": "alice@heroku.com",
  "id": "01234567-89ab-cdef-0123-456789abcdef",
  "last_login": "2012-01-01T12:00:00Z",
  "created_at": "2012-01-01T12:00:00Z",
  "updated_at": "2012-01-01T12:00:00Z"}

而不是:

{"beta":false,"email":"alice@heroku.com","id":"01234567-89ab-cdef-0123-456789abcdef","last_login":"2012-01-01T12:00:00Z", "created_at":"2012-01-01T12:00:00Z","updated_at":"2012-01-01T12:00:00Z"}

要確保在 JSON 結(jié)尾有換行,以防止阻塞用戶的終端界面。

對(duì)于大部分 API 的響應(yīng),性能考濾要優(yōu)先于良好打印。在某些結(jié)點(diǎn)(例如高流量結(jié)點(diǎn))或?yàn)槟承┨囟ㄓ脩簦ɡ鐭o(wú)GUI界面的程序)使用時(shí),你可能會(huì)考濾使用高性能而非良好打印的 API。

注:headless program 譯為“無(wú)顯示界面的程序”,參考自這篇文章.