Restful API的示例分析

這篇文章將為大家詳細(xì)講解有關(guān)Restful API的示例分析，小編覺(jué)得挺實(shí)用的，因此分享給大家做個(gè)參考，希望大家閱讀完這篇文章后可以有所收獲。

Restful：

1. 本質(zhì)：一種軟件架構(gòu)風(fēng)格

2. 核心：面向資源

3. 解決的問(wèn)題：降低開發(fā)的復(fù)雜性，提高系統(tǒng)的可伸縮性

4. 設(shè)計(jì)概念和準(zhǔn)則：

• 網(wǎng)絡(luò)上的所有事物都可以被抽象為資源

• 每一個(gè)資源都有唯一的資源標(biāo)識(shí)，對(duì)資源的操作不會(huì)改變這些標(biāo)識(shí)

• 所有的操作都是無(wú)狀態(tài)的

HTTP協(xié)議：

1. URL：port[服務(wù)器端口，默認(rèn)為80]，path[訪問(wèn)資源的路徑]，query-string[發(fā)送給http服務(wù)器的數(shù)據(jù)]，anchor[錨]

2. 請(qǐng)求：組成格式[請(qǐng)求行、消息報(bào)頭、請(qǐng)求正文]

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

• 請(qǐng)求方法：GET、POST、HEAD、PUT、DELETE、OPTIONS

3. 響應(yīng)：組成格式[狀態(tài)行、消息報(bào)頭、響應(yīng)正文]

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

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

Restful API(六要素)：

1. 資源路徑(URI)：在Restfull架構(gòu)中，每個(gè)網(wǎng)址代碼一種資源，所以網(wǎng)址中不能有動(dòng)詞，只能有名詞。一般來(lái)說(shuō)API中的名詞應(yīng)該使用復(fù)數(shù)。

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

• GET[從服務(wù)器取出資源(一項(xiàng)或多項(xiàng))]

• POST[在服務(wù)器新建一個(gè)資源]

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

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

• DELETE[從服務(wù)器刪除資源]

3. 過(guò)濾信息：如果記錄數(shù)量很多，服務(wù)器不可能都將它們返回給用戶。API應(yīng)該提供參數(shù)，過(guò)濾返回結(jié)果。

4. 狀態(tài)碼：服務(wù)器向用戶返回的狀態(tài)碼和提示信息，使用標(biāo)準(zhǔn)HTTP狀態(tài)碼。

• 200 OK 服務(wù)器成功返回用戶請(qǐng)求的數(shù)據(jù)，該操作是冪等的

• 201 CREATED 新建或修改數(shù)據(jù)成功

• 204 NO CONTENT 刪除數(shù)據(jù)成功

• 400 BAD REQUEST 用戶發(fā)出的請(qǐng)求有錯(cuò)誤，該操作是冪等的

• 401 Unauthorized 表示用戶沒(méi)有認(rèn)證，無(wú)法進(jìn)行當(dāng)前操作

• 403 Forbidden 表示用戶訪問(wèn)是被禁止的

5. 錯(cuò)誤處理：如果狀態(tài)碼是4XX或者5XX，就應(yīng)該向用戶返回出錯(cuò)信息。一般來(lái)說(shuō)，返回的信息中將error作為鍵名，出錯(cuò)信息作為鍵值即可。

• {"error": "參數(shù)錯(cuò)誤"}

6. 返回結(jié)果：針對(duì)不同操作，服務(wù)器向用戶返回的結(jié)果應(yīng)該符合以下規(guī)范

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

• GET /collections/identity[返回單個(gè)資源對(duì)象]

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

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

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

• DELETE /collections/identity[返回一個(gè)空文檔]

關(guān)于“Restful API的示例分析”這篇文章就分享到這里了，希望以上內(nèi)容可以對(duì)大家有一定的幫助，使各位可以學(xué)到更多知識(shí)，如果覺(jué)得文章不錯(cuò)，請(qǐng)把它分享出去讓更多的人看到。