RESTful API 設計詳解
阿新 • • 發佈:2022-04-29
RESTful
是一種軟體架構風格,其面向資源。基於 HTTP 協議實現。
設計概念和準則
- 所有事物都可以被抽象為資源。
- 每一個資源都有唯一的資源標識,對資源的操作不會改變這些標識。
- 所有操作都是無狀態的。
請求方法
-
get
獲取 -
post
附加新的資源 (新建) -
head
請求獲取由 REQUEST-URI 所標識的資源的響應資訊報頭 -
put
請求伺服器儲存一個資源,並用 REQUEST-URI 作為其標識(更新) -
delete
請求伺服器刪除 REQUEST-URI 所標識的資源 -
options
請求查詢伺服器的效能,或者查詢與資源相關的選項與需求
常用狀態碼
-
200
OK -
400
Bad Request 客戶端請求有語法錯誤,不能被伺服器理解 -
401
Unauthorized 伺服器受到請求,但拒絕提供服務 -
404
Not Found -
500
Internal Server Error 伺服器不可預期的錯誤 -
503
Server Unavailable 伺服器當前不能處理客戶端的請求
設計要素
資源路徑 URI
每個網址代表一種資源,網址中不能有動詞,只能是名詞,名詞應該是複數
HTTP 動詞
get、post, etc
過濾資訊
url?offset=10
狀態碼
錯誤處理
{ "error":"錯誤資訊" }