REST API設計規範

 

 

 

1. 徹底面向資源，API以複數形式表示

2. 路徑（Endpoint）

   • http://example.com/libraries //列出全部圖書館

   • http://example.com/books //列出全部圖書

   • http://example.com/libraries/ID/books //列出某個圖書館的所有圖書

   • http://example.com/libraries/ID/books/ID //列出某個圖書館的某本圖書

3. 篩選條件
   

   • http://example.com/books?library_id=ID //參數的存在容許API路徑與URL參數有相同的含義

   • http://example.com/libraries/ID/books?book_type=biography&year=2010 //篩選出2010年出版的傳記類圖書

4. HTTP動詞

• GET 從服務器取出資源

• POST 向服務器新建資源

• PUT 向服務器更新資源（客戶端向服務器提供完整的資源）

• PATCH 向服務器更新資源（客戶端向服務器提供更新的屬性）

• DELETE 刪除資源

5. 狀態碼——經常使用的HTTP狀態碼

• 200 服務器成功返回網頁

• 304 未修改

• 404 請求的網頁未存在

• 503 服務器暫時不可用

• 504 網關超時

• 500 服務器內部錯誤

6. 錯誤處理：若是返回狀態碼是4xx，就應該向客戶端返回錯誤信息，一般將error做爲鍵名，錯誤信息做爲鍵值便可。

   • { error: "Invalid API key" }