RESTful設計方法

1. 域名

應該盡量將API部署在專用域名之下，

https://api.example.com

如果確定API很簡單，不會有進一步擴展，可以考慮放在主域名下，

https://example.org/api/

2. 版本（Versioning）

應該將API的版本號放入URL，

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

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

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

另一種做法是，將版本號放在HTTP頭資訊中，但不如放入URL方便和直觀，Github采用這種做法，

因為不同的版本，可以理解成同一種資源的不同表現形式，所以應該采用同一個URL，版本號可以在HTTP請求頭資訊的Accept欄位中進行區分（參見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）

路徑又稱"終點"（endpoint），表示API的具體網址，每個網址代表一種資源（resource）

(1) 資源作為網址，只能有名詞，不能有動詞，而且所用的名詞往往與資料庫的表名對應，

舉例來說，以下是不好的例子:

/getProducts
/listOrders
/retreiveClientByOrder?orderId=1

對于一個簡潔結構，你應該始終用名詞，此外，利用的HTTP方法可以分離網址中的資源名稱的操作，

GET /products ：將回傳所有產品清單
POST /products ：將產品新建到集合
GET /products/4 ：將獲取產品 4
PATCH（或）PUT /products/4 ：將更新產品 4

(2) API中的名詞應該使用復數，無論子資源或者所有資源，

舉例來說，獲取產品的API可以這樣定義

獲取單個產品：http://127.0.0.1:8080/AppName/rest/products/1
獲取所有產品: http://127.0.0.1:8080/AppName/rest/products

3. HTTP動詞

對于資源的具體操作型別，由HTTP動詞表示，

常用的HTTP動詞有下面四個（括號里是對應的SQL命令），

GET（SELECT）：從服務器取出資源（一項或多項），
POST（CREATE）：在服務器新建一個資源，
PUT（UPDATE）：在服務器更新資源（客戶端提供改變后的完整資源），
DELETE（DELETE）：從服務器洗掉資源，

還有三個不常用的HTTP動詞，

PATCH（UPDATE）：在服務器更新(更新)資源（客戶端提供改變的屬性），
HEAD：獲取資源的元資料，
OPTIONS：獲取資訊，關于資源的哪些屬性是客戶端可以改變的，

下面是一些例子，

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：洗掉某個指定動物園的指定動物

4. 過濾資訊（Filtering）

如果記錄數量很多，服務器不可能都將它們回傳給用戶，API應該提供引數，過濾回傳結果，

下面是一些常見的引數，

?limit=10：指定回傳記錄的數量
?offset=10：指定回傳記錄的開始位置，
?page=2&per_page=100：指定第幾頁，以及每頁的記錄數，
?sortby=name&order=asc：指定回傳結果按照哪個屬性排序，以及排序順序，
?animal_type_id=1：指定篩選條件

引數的設計允許存在冗余，即允許API路徑和URL引數偶爾有重復，比如，GET /zoos/ID/animals 與 GET /animals?zoo_id=ID 的含義是相同的，

6. 狀態碼（Status Codes）

服務器向用戶回傳的狀態碼和提示資訊，常見的有以下一些（方括號中是該狀態碼對應的HTTP動詞），

200 OK - [GET]：服務器成功回傳用戶請求的資料

201 CREATED - [POST]：用戶新建資料成功，

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 - [*]：服務器發生錯誤，用戶將無法判斷發出的請求是否成功，

狀態碼的完全串列參見這里或這里，

7. 錯誤處理（Error handling）

如果狀態碼是4xx，服務器就應該向用戶回傳出錯資訊，一般來說，回傳的資訊中將error作為鍵名，出錯資訊作為鍵值即可，

{
    error: "Invalid API key"
}

8. 回傳結果

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

GET /collection：回傳資源物件的串列（陣列）
GET /collection/resource：回傳單個資源物件
POST /collection：回傳新生成的資源物件
PUT /collection/resource：回傳完整的資源物件
PATCH /collection/resource：回傳完整的資源物件
DELETE /collection/resource：回傳一個空檔案

9. 超媒體（Hypermedia API）

RESTful API最好做到Hypermedia（即回傳結果中提供鏈接，連向其他API方法），使得用戶不查檔案，也知道下一步應該做什么，

比如，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"
}

上面代碼表示，服務器給出了提示資訊，以及檔案的網址，

10. 其他

服務器回傳的資料格式，應該盡量使用JSON，避免使用XML，

轉載請註明出處，本文鏈接：https://www.uj5u.com/houduan/124166.html

標籤：Python

上一篇：《自拍教程71》Python mediainfo批量重命名圖片檔案

下一篇：python 矩陣乘法

03.DRF-設計方法