api與使用者的通訊協議，總是使用https協議。
應該盡量將api部署在專用網域名稱之下。
如果確定api很簡單，不會有進一步擴充套件，可以考慮放在主網域名稱下。
應該將api的版本號放入url。
另一種做法是，將版本號放在http頭資訊中，但不如放入url方便和直觀。github採用這種做法。/v1/
路徑又稱"終點"（endpoint），表示api的具體**。
在restful架構中，每個**代表一種資源（resource），所以**中不能有動詞，只能有名詞，而且所用的名詞往往與資料庫的**名對應。一般來說，資料庫中的表都是同種記錄的"集合"（collection），所以api中的名詞也應該使用複數。
舉例來說，有乙個api提供動物園（zoo）的資訊，還包括各種動物和雇員的資訊，則它的路徑應該設計成下面這樣。
對於資源的具體操作型別，由http動詞表示。常用的http動詞有下面五個（括號裡是對應的sql命令）。
還有兩個不常用的http動詞。 下面是一些例子。 如果記錄數量很多，伺服器不可能都將它們返回給使用者。api應該提供引數，過濾返回結果。下面是一些常見的引數。
引數的設計允許存在冗餘，即允許api路徑和url引數偶爾有重複。比如，get /zoo/id/animals 與 get /animals?zoo_id=id 的含義是相同的。伺服器向使用者返回的狀態碼和提示資訊，常見的有以下一些（方括號中是該狀態碼對應的http動詞）。
狀態碼的完全列表參見這裡。如果狀態碼是4xx，就應該向使用者返回出錯資訊。一般來說，返回的資訊中將error作為鍵名，出錯資訊作為鍵值即可。
針對不同操作，伺服器向使用者返回的結果應該符合以下規範。 最後，我們使用乙個完整的案例將前面介紹的知識整合起來。這裡，使用「獲取使用者列表」的案例。
【get】 /v1/users?[&keyword=***][&enable=1][&offset=0][&limit=20] 獲取使用者列表
功能說明：獲取使用者列表
請求方式：get
引數說明
- keyword: 模糊查詢的關鍵字。[選填]
- enable: 啟用狀態[1-啟用 2-禁用]。[選填]
- offset: 獲取位置偏移，從 0 開始。[選填]
- limit: 每次獲取返回的條數，預設為 20 條，最大不超過 100。 [選填]
響應內容
失敗響應
錯誤**
- 403 uc/auth_denied 授權受限
介面測試 RESTful風格介面
restful架構是一種介面設計架構風格，而不是標準，只是提供了一組設計原則。http 為我們http協議的訪問頭標準 埠號 為我們伺服器內專案訪問的指定編號 專案名稱 版本 可選 3.3 http請求方法 3.4 響應狀態 客戶端請求服務求後，伺服器響應給客戶端的狀態碼。3.5 狀態碼集合彙總 序...
理解restful風格介面
網路應用程式，分為前端和後端兩個部分。當前的發展趨勢，就是前端裝置層出不窮 手機 平板 桌面電腦 其他專用裝置.因此，必須有一種統一的機制，方便不同的前端裝置與後端進行通訊。這導致api構架的流行，甚至出現 api first 的設計思想。restful api是目前比較成熟的一套網際網路應用程式的...
RESTFUL風格的介面命名規範
1.首先restfulf風格的api是基於資源的，url命名用來定位資源，而不是表示動作，動作通過請求方式進行表示。2.url中應該單複數區分，推薦的實踐是永遠只用複數。比如get api users表示獲取使用者的列表，如果獲取單個資源，傳入id，比如 api users 123，表示獲取單個使用...