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

提供可執(zhí)行的例子

提供可執(zhí)行的示例讓用戶可以直接在終端里面看到 API 的調(diào)用情況,最大程度的讓這些示例可以簡單的使用,以減少用戶嘗試使用 API 的工作量。例如:

$ export TOKEN=... # acquire from dashboard
$ curl -is https://$TOKEN@service.com/users

如果你使用prmd生成 Markdown 文檔,每個節(jié)點(diǎn)都會自動獲取一些示例。