鍍金池/ 教程/ Linux/ 使用統(tǒng)一的資源路徑格式
良好打印的默認(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

使用統(tǒng)一的資源路徑格式

資源名稱(chēng)

使用復(fù)數(shù)來(lái)命名資源,除非該資源在系統(tǒng)中是單件(比如,在絕大多數(shù)系統(tǒng)中,一個(gè)用戶只能擁有一個(gè)賬戶)。這樣在你引用特定資源時(shí)可以保持一致性。

對(duì)獨(dú)有的資源使用不需要特定動(dòng)作的 endpoint 格式。這樣當(dāng)需要特定的動(dòng)作,只需要把它們放到標(biāo)準(zhǔn)的 actions 前綴后邊,就可以清晰的描述它們:

/resources/:resource/actions/:action

如:

/runs/{run_id}/actions/stop