一、RESTful風(fēng)格API的好處

API（Application Programming Interface），顧名思義：是一組編程接口規(guī)范，客戶端與服務(wù)端通過(guò)請(qǐng)求響應(yīng)進(jìn)行數(shù)據(jù)通信。REST（Representational State Transfer）表述性狀態(tài)傳遞，決定了接口的形式與規(guī)則。RESTful是基于http方法的API設(shè)計(jì)風(fēng)格，而不是一種新的技術(shù).

• 看Url就知道要什么資源
• 看http method就知道針對(duì)資源干什么
• 看http status code就知道結(jié)果如何

對(duì)接口開(kāi)發(fā)提供了一種可以廣泛適用的規(guī)范，為前端后端交互減少了接口交流的口舌成本，是約定大于配置的體現(xiàn)。通過(guò)下面的設(shè)計(jì)，大家來(lái)理解一下這三句話。

當(dāng)然也不是所有的接口，都能用REST的形式來(lái)表述。在實(shí)際工作中，靈活運(yùn)用，我們用RESTful風(fēng)格的目的是為大家提供統(tǒng)一標(biāo)準(zhǔn)，避免不必要的溝通成本的浪費(fèi)，形成一種通用的風(fēng)格。就好比大家都知道：伸出大拇指表示“你很棒“的意思，絕大部分人都明白，因?yàn)槟懔私饬诉@種風(fēng)格習(xí)慣。但是不排除有些地區(qū)伸出大拇指表示其他意思，就不適合使用！

二、RESTful API的設(shè)計(jì)風(fēng)格

2.1、RESTful是面向資源的（名詞）

REST 通過(guò) URI 暴露資源時(shí)，會(huì)強(qiáng)調(diào)不要在 URI 中出現(xiàn)動(dòng)詞。比如：

2.2、用HTTP方法體現(xiàn)對(duì)資源的操作（動(dòng)詞）

GET ： 獲取、讀取資源

POST ： 添加資源

PUT ： 修改資源

DELETE ： 刪除資源

實(shí)際上，這四個(gè)動(dòng)詞實(shí)際上就對(duì)應(yīng)著增刪改查四個(gè)操作，這就利用了HTTP動(dòng)詞來(lái)表示對(duì)資源的操作。

2.3. HTTP狀態(tài)碼

通過(guò)HTTP狀態(tài)碼體現(xiàn)動(dòng)作的結(jié)果,不要自定義

200 OK 
400 Bad Request 
500 Internal Server Error

在 APP 與 API 的交互當(dāng)中，其結(jié)果逃不出這三種狀態(tài)：

• 所有事情都按預(yù)期正確執(zhí)行完畢 - 成功
• APP 發(fā)生了一些錯(cuò)誤 – 客戶端錯(cuò)誤（如：校驗(yàn)用戶輸入身份證，結(jié)果輸入的是軍官證，就是客戶端輸入錯(cuò)誤）
• API 發(fā)生了一些錯(cuò)誤 – 服務(wù)器端錯(cuò)誤（各種編碼bug或服務(wù)內(nèi)部自己導(dǎo)致的異常）

這三種狀態(tài)與上面的狀態(tài)碼是一一對(duì)應(yīng)的。如果你覺(jué)得這三種狀態(tài)，分類處理結(jié)果太寬泛，http-status code還有很多。建議還是要遵循KISS(Keep It Stupid and Simple)原則，上面的三種狀態(tài)碼完全可以覆蓋99%以上的場(chǎng)景。這三個(gè)狀態(tài)碼大家都記得住，而且非常常用，多了就不一定了。

2.4. Get方法和查詢參數(shù)不應(yīng)該改變數(shù)據(jù)

改變數(shù)據(jù)的事交給POST、PUT、DELETE

2.5. 使用復(fù)數(shù)名詞

/dogs 而不是 /dog

2.6. 復(fù)雜資源關(guān)系的表達(dá)

GET /cars/711/drivers/ 返回 使用過(guò)編號(hào)711汽車的所有司機(jī)

GET /cars/711/drivers/4 返回 使用過(guò)編號(hào)711汽車的4號(hào)司機(jī)

2.7. 高級(jí)用法:HATEOAS

HATEOAS:Hypermedia as the Engine of Application State 超媒體作為應(yīng)用狀態(tài)的引擎。
RESTful API最好做到HATEOAS，即返回結(jié)果中提供鏈接，連向其他API方法，使得用戶不查文檔，也知道下一步應(yīng)該做什么。比如，當(dāng)用戶向api.example.com的根目錄發(fā)出請(qǐng)求，會(huì)得到這樣一個(gè)文檔。

{"link": {
  "rel":   "collection https://www.example.com/zoos",
  "href":  "https://api.example.com/zoos",
  "title": "List of zoos",
  "type":  "application/vnd.yourformat+json"
}}

上面代碼表示，文檔中有一個(gè)link屬性，用戶讀取這個(gè)屬性就知道下一步該調(diào)用什么API或者可以調(diào)用什么API了。

2.8. 資源過(guò)濾、排序、選擇和分頁(yè)的表述

2.9. 版本化你的API

強(qiáng)制性增加API版本聲明，不要發(fā)布無(wú)版本的API。如：/api/v1/blog

面向擴(kuò)展開(kāi)放，面向修改關(guān)閉：也就是說(shuō)一個(gè)版本的接口開(kāi)發(fā)完成測(cè)試上線之后，我們一般不會(huì)對(duì)接口進(jìn)行修改，如果有新的需求就開(kāi)發(fā)新的接口進(jìn)行功能擴(kuò)展。這樣做的目的是：當(dāng)你的新接口上線后，不會(huì)影響使用老接口的用戶。如果新接口目的是替換老接口，也不要在v1版本原接口上修改，而是開(kāi)發(fā)v2版本接口，并聲明v1接口廢棄！

參考：

關(guān)于HTTP RESTful風(fēng)格API設(shè)計(jì)的更多例子，請(qǐng)大家參考：http://httpbin.org/

以上就是Spring Boot開(kāi)發(fā)RESTful接口與http協(xié)議狀態(tài)表述的詳細(xì)內(nèi)容，更多關(guān)于Spring Boot開(kāi)發(fā)RESTful接口http狀態(tài)的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

最新評(píng)論