Restful API的示例分析

這篇文章將為大家詳細講解有關Restful API的示例分析，小編覺得挺實用的，因此分享給大家做個參考，希望大家閱讀完這篇文章后可以有所收獲。

Restful：

1. 本質：一種軟件架構風格

2. 核心：面向資源

3. 解決的問題：降低開發的復雜性，提高系統的可伸縮性

4. 設計概念和準則：

• 網絡上的所有事物都可以被抽象為資源

• 每一個資源都有唯一的資源標識，對資源的操作不會改變這些標識

• 所有的操作都是無狀態的

HTTP協議：

1. URL：port[服務器端口，默認為80]，path[訪問資源的路徑]，query-string[發送給http服務器的數據]，anchor[錨]

2. 請求：組成格式[請求行、消息報頭、請求正文]

• 請求行：格式[Method Request-URI HTTP-Version CRLF]，舉例[GET / HTTP/1.1 CRLF]

• 請求方法：GET、POST、HEAD、PUT、DELETE、OPTIONS

3. 響應：組成格式[狀態行、消息報頭、響應正文]

• 狀態行：格式[HTTP-Version Status-Code Reason-Phrase CRLF]，舉例[HTTP/1.1 200 OK]

• 常用狀態碼：200 OK，400 Bad Request，401 Unauthorized，404 Not Found，500 Internal Server Error，503 Server Unavailable

Restful API(六要素)：

1. 資源路徑(URI)：在Restfull架構中，每個網址代碼一種資源，所以網址中不能有動詞，只能有名詞。一般來說API中的名詞應該使用復數。

2. HTTP動詞：對于資源的操作(CURD)，由HTTP動詞(謂詞)表示。

• GET[從服務器取出資源(一項或多項)]

• POST[在服務器新建一個資源]

• PUT[在服務器更新資源(客戶端提供改變后的完整資源)]

• PATCH[在服務器更新資源(客戶端提供改變的屬性)]

• DELETE[從服務器刪除資源]

3. 過濾信息：如果記錄數量很多，服務器不可能都將它們返回給用戶。API應該提供參數，過濾返回結果。

4. 狀態碼：服務器向用戶返回的狀態碼和提示信息，使用標準HTTP狀態碼。

• 200 OK 服務器成功返回用戶請求的數據，該操作是冪等的

• 201 CREATED 新建或修改數據成功

• 204 NO CONTENT 刪除數據成功

• 400 BAD REQUEST 用戶發出的請求有錯誤，該操作是冪等的

• 401 Unauthorized 表示用戶沒有認證，無法進行當前操作

• 403 Forbidden 表示用戶訪問是被禁止的

5. 錯誤處理：如果狀態碼是4XX或者5XX，就應該向用戶返回出錯信息。一般來說，返回的信息中將error作為鍵名，出錯信息作為鍵值即可。

• {"error": "參數錯誤"}

6. 返回結果：針對不同操作，服務器向用戶返回的結果應該符合以下規范

• GET /collections[返回資源對象的列表(數組)]

• GET /collections/identity[返回單個資源對象]

• POST /collections[返回新生成的資源對象]

• PUT /collections/identity[返回完整的資源對象]

• PATCH /collections/identity[返回被修改的屬性]

• DELETE /collections/identity[返回一個空文檔]

關于“Restful API的示例分析”這篇文章就分享到這里了，希望以上內容可以對大家有一定的幫助，使各位可以學到更多知識，如果覺得文章不錯，請把它分享出去讓更多的人看到。