restful如何設(shè)計(jì)

這篇文章主要介紹restful如何設(shè)計(jì)，文中示例代碼介紹的非常詳細(xì)，具有一定的參考價(jià)值，感興趣的小伙伴們一定要看完！

restful設(shè)計(jì)方法：

1、域名

應(yīng)該盡量將API部署在專用域名之下。

https://api.example.com

如果確定API很簡(jiǎn)單，不會(huì)有進(jìn)一步擴(kuò)展，可以考慮放在主域名下。

https://example.org/api/

2、版本

應(yīng)該將API的版本號(hào)放入U(xiǎn)RL。

http://www.example.com/api/1.0/foo
http://www.example.com/api/1.1/foo
http://www.example.com/api/2.0/foo

另一種做法是，將版本號(hào)放在HTTP頭信息中，但不如放入U(xiǎn)RL方便和直觀。Github采用這種做法。

因?yàn)椴煌陌姹?，可以理解成同一種資源的不同表現(xiàn)形式，所以應(yīng)該采用同一個(gè)URL。版本號(hào)可以在HTTP請(qǐng)求頭信息的Accept字段中進(jìn)行區(qū)分（參見(jiàn)Versioning REST Services）：

Accept: vnd.example-com.foo+json; version=1.0
Accept: vnd.example-com.foo+json; version=1.1
Accept: vnd.example-com.foo+json; version=2.0

3、路徑（Endpoint）

路徑又稱"終點(diǎn)"（endpoint），表示API的具體網(wǎng)址，每個(gè)網(wǎng)址代表一種資源（resource）

(1) 資源作為網(wǎng)址，只能有名詞，不能有動(dòng)詞，而且所用的名詞往往與數(shù)據(jù)庫(kù)的表名對(duì)應(yīng)。

舉例來(lái)說(shuō)，以下是不好的例子:

/getProducts
/listOrders
/retreiveClientByOrder?orderId=1

對(duì)于一個(gè)簡(jiǎn)潔結(jié)構(gòu)，你應(yīng)該始終用名詞。 此外，利用的HTTP方法可以分離網(wǎng)址中的資源名稱的操作。

GET /products ：將返回所有產(chǎn)品清單
POST /products ：將產(chǎn)品新建到集合
GET /products/4 ：將獲取產(chǎn)品 4
PATCH（或）PUT /products/4 ：將更新產(chǎn)品 4

(2) API中的名詞應(yīng)該使用復(fù)數(shù)。無(wú)論子資源或者所有資源。

舉例來(lái)說(shuō)，獲取產(chǎn)品的API可以這樣定義

獲取單個(gè)產(chǎn)品：http://127.0.0.1:8080/AppName/rest/products/1
獲取所有產(chǎn)品: http://127.0.0.1:8080/AppName/rest/products

4、HTTP動(dòng)詞

對(duì)于資源的具體操作類型，由HTTP動(dòng)詞表示。

常用的HTTP動(dòng)詞有下面四個(gè)（括號(hào)里是對(duì)應(yīng)的SQL命令）。

GET（SELECT）：從服務(wù)器取出資源（一項(xiàng)或多項(xiàng)）。
POST（CREATE）：在服務(wù)器新建一個(gè)資源。
PUT（UPDATE）：在服務(wù)器更新資源（客戶端提供改變后的完整資源）。
DELETE（DELETE）：從服務(wù)器刪除資源。

還有三個(gè)不常用的HTTP動(dòng)詞。

PATCH（UPDATE）：在服務(wù)器更新(更新)資源（客戶端提供改變的屬性）。
HEAD：獲取資源的元數(shù)據(jù)。
OPTIONS：獲取信息，關(guān)于資源的哪些屬性是客戶端可以改變的。

下面是一些例子。

GET /zoos：列出所有動(dòng)物園
POST /zoos：新建一個(gè)動(dòng)物園（上傳文件）
GET /zoos/ID：獲取某個(gè)指定動(dòng)物園的信息
PUT /zoos/ID：更新某個(gè)指定動(dòng)物園的信息（提供該動(dòng)物園的全部信息）
PATCH /zoos/ID：更新某個(gè)指定動(dòng)物園的信息（提供該動(dòng)物園的部分信息）
DELETE /zoos/ID：刪除某個(gè)動(dòng)物園
GET /zoos/ID/animals：列出某個(gè)指定動(dòng)物園的所有動(dòng)物
DELETE /zoos/ID/animals/ID：刪除某個(gè)指定動(dòng)物園的指定動(dòng)物

5、過(guò)濾信息（Filtering）

如果記錄數(shù)量很多，服務(wù)器不可能都將它們返回給用戶。API應(yīng)該提供參數(shù)，過(guò)濾返回結(jié)果。
下面是一些常見(jiàn)的參數(shù)。
?limit=10：指定返回記錄的數(shù)量
?offset=10：指定返回記錄的開(kāi)始位置。
?page=2&per_page=100：指定第幾頁(yè)，以及每頁(yè)的記錄數(shù)。
?sortby=name&order=asc：指定返回結(jié)果按照哪個(gè)屬性排序，以及排序順序。
?animal_type_id=1：指定篩選條件

參數(shù)的設(shè)計(jì)允許存在冗余，即允許API路徑和URL參數(shù)偶爾有重復(fù)。比如，GET /zoos/ID/animals 與 GET /animals?zoo_id=ID 的含義是相同的。

6、狀態(tài)碼

服務(wù)器向用戶返回的狀態(tài)碼和提示信息，常見(jiàn)的有以下一些（方括號(hào)中是該狀態(tài)碼對(duì)應(yīng)的HTTP動(dòng)詞）。

200 OK - [GET]：服務(wù)器成功返回用戶請(qǐng)求的數(shù)據(jù)
201 CREATED - [POST]：用戶新建數(shù)據(jù)成功。
202 Accepted - [*]：表示一個(gè)請(qǐng)求已經(jīng)進(jìn)入后臺(tái)排隊(duì)（異步任務(wù)）
204 NO CONTENT - [DELETE]：用戶刪除數(shù)據(jù)成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用戶發(fā)出的請(qǐng)求有錯(cuò)誤，服務(wù)器沒(méi)有進(jìn)行新建或修改數(shù)據(jù)的操作
401 Unauthorized - [*]：表示用戶沒(méi)有權(quán)限（令牌、用戶名、密碼錯(cuò)誤）。
403 Forbidden - [*] 表示用戶得到授權(quán)（與401錯(cuò)誤相對(duì)），但是訪問(wèn)是被禁止的。
404 NOT FOUND - [*]：用戶發(fā)出的請(qǐng)求針對(duì)的是不存在的記錄，服務(wù)器沒(méi)有進(jìn)行操作，該操作是冪等的。
406 Not Acceptable - [GET]：用戶請(qǐng)求的格式不可得（比如用戶請(qǐng)求JSON格式，但是只有XML格式）。
410 Gone -[GET]：用戶請(qǐng)求的資源被永久刪除，且不會(huì)再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 當(dāng)創(chuàng)建一個(gè)對(duì)象時(shí)，發(fā)生一個(gè)驗(yàn)證錯(cuò)誤。
500 INTERNAL SERVER ERROR - [*]：服務(wù)器發(fā)生錯(cuò)誤，用戶將無(wú)法判斷發(fā)出的請(qǐng)求是否成功。

7、錯(cuò)誤處理

如果狀態(tài)碼是4xx，服務(wù)器就應(yīng)該向用戶返回出錯(cuò)信息。一般來(lái)說(shuō)，返回的信息中將error作為鍵名，出錯(cuò)信息作為鍵值即可。

{
    error: "Invalid API key"
}

8、返回結(jié)果

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

GET /collection：返回資源對(duì)象的列表（數(shù)組）
GET /collection/resource：返回單個(gè)資源對(duì)象
POST /collection：返回新生成的資源對(duì)象
PUT /collection/resource：返回完整的資源對(duì)象
PATCH /collection/resource：返回完整的資源對(duì)象
DELETE /collection/resource：返回一個(gè)空文檔

9、超媒體

RESTful API最好做到Hypermedia（即返回結(jié)果中提供鏈接，連向其他API方法），使得用戶不查文檔，也知道下一步應(yīng)該做什么。

比如，Github的API就是這種設(shè)計(jì)，訪問(wèn)api.github.com會(huì)得到一個(gè)所有可用API的網(wǎng)址列表。

{
"current_user_url": "https://api.github.com/user",
"authorizations_url": "https://api.github.com/authorizations",
// ...
}

從上面可以看到，如果想獲取當(dāng)前用戶的信息，應(yīng)該去訪問(wèn)api.github.com/user，然后就得到了下面結(jié)果。

{
  "message": "Requires authentication",
  "documentation_url": "https://developer.github.com/v3"
}

上面代碼表示，服務(wù)器給出了提示信息，以及文檔的網(wǎng)址。

以上是restful如何設(shè)計(jì)的所有內(nèi)容，感謝各位的閱讀！希望分享的內(nèi)容對(duì)大家有幫助，更多相關(guān)知識(shí)，歡迎關(guān)注億速云行業(yè)資訊頻道！