Linux统一编程接口,restful接口设计规范总结
一、重要概念：REST,即Representational State Transfer的縮寫。我對這個詞組的翻譯是"表現層狀態轉化"。
Resource(資源) ：對象的單個實例。 例如，一只動物。它可以是一段文本、一張圖片、一首歌曲、一種服務，總之就是一個具體的實在。
你可以用一個URI(統一資源定位符)指向它，每種資源對應一個特定的URI。要獲取這個資源，訪問它的URI就可以，因此URI就成了每一個資源的地址或獨一無二的識別符。
集合：對象的集合。 例如，動物。
第三方：使用我們接口的開發者
表現層(Representation)
"資源"是一種信息實體，它可以有多種外在表現形式。我們把"資源"具體呈現出來的形式，叫做它的"表現層"(Representation)。
狀態轉化(State Transfer)
訪問一個網站，就代表了客戶端和服務器的一個互動過程。在這個過程中，勢必涉及到數據和狀態的變化。互聯網通信協議HTTP協議，是一個無狀態協議。這意味著，
所有的狀態都保存在服務器端。因此，如果客戶端想要操作服務器，必須通過某種手段，讓服務器端發生"狀態轉化"(State Transfer)。而這種轉化是建立在表現層之上的，
所以就是"表現層狀態轉化"。
客戶端用到的手段，只能是HTTP協議。具體來說，就是HTTP協議里面，四個表示操作方式的動詞：GET、POST、PUT、DELETE。
它們分別對應四種基本操作：GET用來獲取資源，POST用來新建資源(也可以用于更新資源)，PUT用來更新資源，DELETE用來刪除資源。
比如，文本可以用txt格式表現，也可以用HTML格式、XML格式、JSON格式表現，甚至可以采用二進制格式；圖片可以用JPG格式表現，也可以用PNG格式表現。
URI只代表資源的實體，不代表它的形式。嚴格地說，有些網址最后的".html"后綴名是不必要的，因為這個后綴名表示格式，屬于"表現層"范疇，
而URI應該只代表"資源"的位置。它的具體表現形式，應該在HTTP請求的頭信息中用Accept和Content-Type字段指定，這兩個字段才是對"表現層"的描述。
綜合上面的解釋，我們總結一下什么是RESTful架構：
(1)每一個URI代表一種資源；
(2)客戶端和服務器之間，傳遞這種資源的某種表現層；
(3)客戶端通過四個HTTP動詞，對服務器端資源進行操作，實現"表現層狀態轉化"。
二、REST接口規范
1、動作
GET (SELECT)：從服務器檢索特定資源，或資源列表。
POST (CREATE)：在服務器上創建一個新的資源。
PUT (UPDATE)：更新服務器上的資源，提供整個資源。
PATCH (UPDATE)：更新服務器上的資源，僅提供更改的屬性。
DELETE (DELETE)：從服務器刪除資源。
首先是四個半種動作：
post、delete、put/patch、get
因為put/patch只能算作一類，所以將patch歸為半個。
另外還有有兩個較少知名的HTTP動詞：
HEAD - 檢索有關資源的元數據，例如數據的哈希或上次更新時間。
OPTIONS - 檢索關于客戶端被允許對資源做什么的信息。
2、路徑(接口命名)
路徑又稱"終點"(endpoint)，表示API的具體網址。
在RESTful架構中，每個網址代表一種資源(resource)，所以網址中不能有動詞，只能有名詞，而且所用的名詞往往與數據庫的表格名對應。一般來說，數據庫中的表都是同種記錄的"集合"(collection)，所以API中的名詞也應該使用復數。
舉例來說，有一個API提供動物園(zoo)的信息，還包括各種動物和雇員的信息，則它的路徑應該設計成下面這樣。
接口盡量使用名詞，禁止使用動詞，下面是一些例子。
GET? ? ? ? /zoos：列出所有動物園
POST? ? ? ? /zoos：新建一個動物園
GET? ? ? ? /zoos/ID：獲取某個指定動物園的信息
PUT? ? ? ? /zoos/ID：更新某個指定動物園的信息(提供該動物園的全部信息)
PATCH? ? ? /zoos/ID：更新某個指定動物園的信息(提供該動物園的部分信息)
DELETE? ? ? /zoos/ID：刪除某個動物園
GET? ? ? ? /zoos/ID/animals：列出某個指定動物園的所有動物
DELETE? ? ? /zoos/ID/animals/ID：刪除某個指定動物園的指定動物
反例：
/getAllCars
/createNewCar
/deleteAllRedCars
再比如，某個URI是/posts/show/1，其中show是動詞，這個URI就設計錯了，正確的寫法應該是/posts/1，然后用GET方法表示show。
如果某些動作是HTTP動詞表示不了的，你就應該把動作做成一種資源。比如網上匯款，從賬戶1向賬戶2匯款500元，錯誤的URI是：
POST /accounts/1/transfer/500/to/2
正確的寫法是把動詞transfer改成名詞transaction，資源不能是動詞，但是可以是一種服務：
POST /transaction HTTP/1.1
Host: 127.0.0.1
from=1&to=2&amount=500.00
理清資源的層次結構，比如業務針對的范圍是學校，那么學校會是一級資源(/school)，老師(/school/teachers)，學生(/school/students)就是二級資源。
3、版本(Versioning)
應該將API的版本號放入URL。如：
https://api.example.com/v1/
另一種做法是，將版本號放在HTTP頭信息中，但不如放入URL方便和直觀。Github采用這種做法。
4、過濾信息(Filtering)
如果記錄數量很多，服務器不可能都將它們返回給用戶。API應該提供參數，過濾返回結果。
下面是一些常見的參數。
?limit=10：指定返回記錄的數量
?offset=10：指定返回記錄的開始位置。
?page_number=2&page_size=100：指定第幾頁，以及每頁的記錄數。
?sortby=name&order=asc：指定返回結果按照哪個屬性排序，以及排序順序。
?animal_type_id=1：指定篩選條件
參數的設計允許存在冗余，即允許API路徑和URL參數偶爾有重復。比如，
GET /zoo/ID/animals 與 GET /animals?zoo_id=ID 的含義是相同的。
5、狀態碼(Status Codes)
狀態碼范圍
1xx 信息，請求收到，繼續處理。范圍保留用于底層HTTP的東西，你很可能永遠也用不到。
2xx 成功，行為被成功地接受、理解和采納
3xx 重定向，為了完成請求，必須進一步執行的動作
4xx 客戶端錯誤，請求包含語法錯誤或者請求無法實現。范圍保留用于響應客戶端做出的錯誤，例如。他們提供不良數據或要求不存在的東西。這些請求應該是冪等的，而不是更改服務器的狀態。
5xx 范圍的狀態碼是保留給服務器端錯誤用的。這些錯誤常常是從底層的函數拋出來的，甚至
開發人員也通常沒法處理，發送這類狀態碼的目的以確保客戶端獲得某種響應。
當收到5xx響應時，客戶端不可能知道服務器的狀態，所以這類狀態碼是要盡可能的避免。
服務器向用戶返回的狀態碼和提示信息，常見的有以下一些(方括號中是該狀態碼對應的HTTP動詞)。
200 OK - [GET]：服務器成功返回用戶請求的數據，該操作是冪等的(Idempotent)。
201 CREATED - [POST/PUT/PATCH]：用戶新建或修改數據成功。
202 Accepted - [*]：表示一個請求已經進入后臺排隊(異步任務)
204 NO CONTENT - [DELETE]：用戶刪除數據成功。
400 INVALID REQUEST - [POST/PUT/PATCH]：用戶發出的請求有錯誤，服務器沒有進行新建或修改數據的操作，該操作是冪等的。
401 Unauthorized - [*]：表示用戶沒有權限(令牌、用戶名、密碼錯誤)。
403 Forbidden - [*] 表示用戶得到授權(與401錯誤相對)，但是訪問是被禁止的。
404 NOT FOUND - [*]：用戶發出的請求針對的是不存在的記錄，服務器沒有進行操作，該操作是冪等的。
406 Not Acceptable - [GET]：用戶請求的格式不可得(比如用戶請求JSON格式，但是只有XML格式)。
410 Gone -[GET]：用戶請求的資源被永久刪除，且不會再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 當創建一個對象時，發生一個驗證錯誤。
500 INTERNAL SERVER ERROR - [*]：服務器發生錯誤，用戶將無法判斷發出的請求是否成功。
502 網關錯誤
503 Service Unavailable
504 網關超時
錯誤處理(Error handling)
如果狀態碼是4xx，就應該向用戶返回出錯信息。一般來說，返回的信息中將error作為鍵名，出錯信息作為鍵值即可。
{
error: "Invalid API key"
}
返回結果
針對不同操作，服務器向用戶返回的結果應該符合以下規范。
GET /collection：返回資源對象的列表(數組)
GET /collection/resource：返回單個資源對象
POST /collection：返回新生成的資源對象
PUT /collection/resource：返回完整的資源對象
PATCH /collection/resource：返回完整的資源對象
DELETE /collection/resource：返回一個空文檔
Hypermedia API
RESTful API最好做到Hypermedia，即返回結果中提供鏈接，連向其他API方法，使得用戶不查文檔，也知道下一步應該做什么。
比如，當用戶向api.example.com的根目錄發出請求，會得到這樣一個文檔。
{"link": {
"rel":? "collection https://www.example.com/zoos",
"href":? "https://api.example.com/zoos",
"title": "List of zoos",
"type":? "application/vnd.yourformat+json"
}}
上面代碼表示，文檔中有一個link屬性，用戶讀取這個屬性就知道下一步該調用什么API了。rel表示這個API與當前網址的關系(collection關系，并給出該collection的網址)，href表示API的路徑，title表示API的標題，type表示返回類型。
Hypermedia API的設計被稱為HATEOAS。Github的API就是這種設計，訪問api.github.com會得到一個所有可用API的網址列表。
{
"current_user_url": "https://api.github.com/user",
"authorizations_url": "https://api.github.com/authorizations",
// ...
}
從上面可以看到，如果想獲取當前用戶的信息，應該去訪問api.github.com/user，然后就得到了下面結果。
{
"message": "Requires authentication",
"documentation_url": "https://developer.github.com/v3"
}
上面代碼表示，服務器給出了提示信息，以及文檔的網址。
總結
以上是生活随笔為你收集整理的Linux统一编程接口,restful接口设计规范总结的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： c语言姓名号码,c语言如何输入编号和姓名
- 下一篇： linux 文件怎么不让删,请问如何设置