restFul介面設計規範[僅供參考]

PENGJUNQIAO發表於2022-03-01
REST
  1. 域名

應該儘量將API部署在專用域名之下。

https://api.example.com

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

https://www.example.org/api/
  1. 版本（Versioning）

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

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

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

http://www.example.com/app/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
  1. 路徑（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
  1. HTTP動詞

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

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

  • GET（SELECT）：從伺服器取出資源（一項或多項）。

  • POST（CREATE）：在伺服器新建一個資源。

  • PUT（UPDATE）：在伺服器更新資源（客戶端提供改變後的完整資源）。

  • DELETE（DELETE）：從伺服器刪除資源。

    CURD Create、Update、Read、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：刪除某個指定動物園的指定動物
  1. 過濾資訊（Filtering）

如果記錄數量很多，伺服器不可能都將它們返回給使用者。API應該提供引數，過濾返回結果。

下面是一些常見的引數。query_string 查詢字串,位址列後面問號後面的資料,格式: name=xx&sss=xxx

完整的URL地址格式：
協議://域名(IP):埠號/students/?查詢字串#錨點

查詢字串: query_srting
格式與請求體型別：
    username=xiaoming&class=301



?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 的含義是相同的。

  1. 狀態碼（Status Codes）

    1xx 表示當前本次請求還是持續，沒結束
    2xx 表示當前本次請求成功/完成了
    3xx 表示當前本次請求成功，但是伺服器進行代理操作/重定向
    4xx 表示當前本次請求失敗，主要是客戶端發生了錯誤
    5xx 表示當前本次請求失敗，主要是伺服器發生了錯誤

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

  • 101 Switching Protocols - [*] 協議進行中，一般在http升級到websocket協議的時候就看到
  • 200 OK - [GET]：伺服器成功返回使用者請求的資料
  • 201 CREATED - [POST/PUT/PATCH]：使用者新建或修改資料成功。
  • 202 Accepted - [*]：表示一個請求已經進入後臺排隊（非同步任務）
  • 204 NO CONTENT - [DELETE]：使用者刪除資料成功。
  • 301 Moved Permanently - [*]: 永久重定向
  • 302 Move Temporarily - [*]: 臨時重定向
  • 304 Not Modified - [*]: 命中快取
  • 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 - [*]：伺服器發生錯誤，使用者將無法判斷髮出的請求是否成功。
  • 507 Insufficient Storage [POST/PUT/PATCH] 資料儲存出錯，往往資料庫操作錯誤出錯，伺服器就返回這個

狀態碼的完全列表參見這裡或這裡。

  1. 錯誤處理（Error handling）

如果狀態碼是4xx或者5xx，伺服器就應該向使用者返回出錯資訊。一般來說，返回的資訊中將error作為鍵名，出錯資訊作為鍵值即可。一般格式都是json格式。

{
    error: "Invalid API key"
}
  1. 返回結果

restful針對不同操作，伺服器向使用者返回的結果應該符合以下規範。

  • GET /collections：返回資源物件的列表（陣列）
  • GET /collections/ID：返回單個資源字典(json)
  • POST /collections：返回新生成的資源字典(json)
  • PUT /collections/ID：返回修改後的資源字典(json)
  • DELETE /collections/ID：返回一個空文件(空字串，空字典)
  1. 超媒體（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"
}

上面程式碼表示，伺服器給出了提示資訊，以及文件的網址。

  1. 其他

伺服器返回的資料格式，應該儘量使用JSON，避免使用XML。

XML（eXtend Markup Language，可擴充套件標記語言）是W3C為了替換HTML研發出來的，但是現在很明顯失敗了。

語法：

1. xml常用場景：配置檔案 微信開發  小程式  安卓

2. xml就是網頁文件，檔案以 .xml結尾

3. xml文件必須以文件宣告開頭，所有的xml文件內容都必須寫在自定義的根標籤內，xml文件有且只有1個根標籤。
<xml version="1.0" charset="utf-8">
<根標籤>
    ..... xml文件內容
</根標籤>

4. xml裡面也是由標籤組成頁面的。標籤分單標籤和雙標籤。其中，
   單標籤寫法： <標籤名/>
   雙標籤寫法： <標籤名></標籤名>

5. xml標籤名除了文件宣告，其他標籤名和屬性全部是開發人員自己自定義的。

6. 標籤有0個或多個屬性，屬性必須有屬性值。而且屬性值必須使用引號圈起來。
<標籤名 屬性名="屬性值" .../>
<標籤名 屬性名="屬性值" ...>標籤內容</標籤名>

xml文件舉例：

<?xml version="1.0" encoding="utf-8" ?>
<student-list>
<!-- 	<student>
	   <name>小紅</name>
	   <age>17</age>
	   <sex>女</sex>
	   <class>301</class>
	</student>
	<student>
	   <name>小紅</name>
	   <age>17</age>
	   <sex>女</sex>
	   <class>301</class>
	</student> -->
	<student age="17" sex="男" class="301">小明</student>
	<student age="17" sex="男" class="301">小明</student>
	<student age="17" sex="男" class="301">小明</student>
	<student age="17" sex="男" class="301">小明</student>
	<student age="17" sex="男" class="301">小明</student>
</student-list>

json是目前市面上最流行的資料傳輸格式。JavaScript Object Notation js物件表示法

語法：

# 1. json檔案以 .json結尾，一個json檔案中只能儲存一個json物件或者一個json陣列
# 2. json中的屬性型別：
  陣列    []                       # python->列表
  物件    {}                       # python->字典
  數值    整型，浮點型，布林值   
  字串  雙引號圈起來的文字內容
  null    空

# 3. 陣列和物件的成員之間必須以英文逗號隔開，並且最後一個子成員後面不能出現逗號
# 4. json物件只能有屬性不能出現方法，而且屬性名必須以字串格式來編寫

舉例1：

{
    "name": "張三",
    "sex": true,
    "age": 38,
    "money": 88.5,
    "child":{
        "name": "張思",
        "sex": false,
        "age": 4
    },
    "lve":["code","TV","swimming"]
}

舉例2：

[
    {
        "name":"小明",
        "sex":true,
    },{
        "name":"小灰",
        "sex":true,
    }
]

使用xml和json表述一本書的內容資訊，書的欄位：

name varchar

price float

author varchar

pub_data date

word_total int

xml

<?xml version="1.0" encoding="utf-8" ?>
<book>
	<name>西遊記</name>
	<price>9999</price>
	<author>內容~~~適合多看</author>
	<pub_data>2020-9-8</pub_data>
	<word_total>999</word_total>
</book>

json

{
	"name":"三國演義",
	"price":1,
	"author":"諸葛亮草船借箭。。。",
	"pub_data":"2000-1-1",
	"word_total":50
}

http://www.xx.com:80/students?username=xiaoming&pwd=123

協議名://域名:埠/路徑?查詢字串

課外補充：

1. python關於操作xml：  lxml
2. python關於操作json： json, ujson, orjson(rust)

相關文章