為了保證持續和及時的更新，強烈推薦在我的github上關注該專案，歡迎各位star/fork或者幫助翻譯這篇指南介紹描述了 http+json api 的一種設計模式，最初摘錄整理自 heroku 平台的 api 設計指引 heroku 平台 api 指引。
這篇指南除了詳細介紹現有的 api 外，heroku 將來新加入的內部 api 也會符合這種設計模式，我們希望非 heroku 員工的api設計者也能感興趣。
我們的目標是保持一致性，專注業務邏輯同時避免過度設計。我們一直試圖找出一種良好的、一致的、顯而易見的 api 設計方法，而並不是所謂的"最終/理想模式"。
我們假設你熟悉基本的 http+json api 設計方法，所以本篇指南並不包含所有的 api 設計基礎。
我們歡迎你為這篇指南做貢獻。
提供乙個機器可讀的模式來恰當的表現你的api。使用
prmd管理你的模式，並且確保用prmd verify驗證是有效的。
提供人類可讀的文件讓客戶端開發人員可以理解你的api。
如果你用prmd建立了乙個概要並且按上述要求描述，你可以為所有節點很容易的使用prmd doc生成markdown文件。
除了節點資訊，提供乙個api概述資訊:
提供可執行的示例讓使用者可以直接在終端裡面看到api的呼叫情況，最大程度的讓這些示例可以簡單的使用，以減少使用者嘗試使用api的工作量。例如:
$ export token=... # acquire from dashboard
$ curl -is https://[email protected]/users
描述您的api的穩定性或是它在各種各樣節點環境中的完備性和穩定性，例如：加上 原型版（prototype）/開發版（development）/產品版（production）等標記。
更多關於可能的穩定性和改變管理的方式，檢視 heroku api compatibility policy
一旦你的api宣布產品正式版本及穩定版本時，不要在當前api版本中做一些不相容的改變。如果你需要，請建立乙個新的版本的api。
HTTP API 設計指南（響應部分）
這篇指南介紹描述了 http json api 的一種設計模式，最初摘錄整理自 heroku 平台的 api 設計指引 heroku 平台 api 指引。這篇指南除了詳細介紹現有的 api 外，heroku 將來新加入的內部 api 也會符合這種設計模式，我們希望非 heroku 員工的api設計者...
HTTP API 設計指南（基礎部分）
這篇指南介紹描述了 http json api 的一種設計模式，最初摘錄整理自 heroku 平台的 api 設計指引 heroku 平台 api 指引。這篇指南除了詳細介紹現有的 api 外，heroku 將來新加入的內部 api 也會符合這種設計模式，我們希望非 heroku 員工的api設計者...
HTTP API 設計指南（基礎部分）
為了保證持續和及時的更新，強烈推薦在我的github上關注該專案，歡迎各位star fork或者幫助翻譯 這篇指南介紹描述了 http json api 的一種設計模式，最初摘錄整理自 heroku 平台的 api 設計指引 heroku 平台 api 指引。這篇指南除了詳細介紹現有的 api 外，...