1 API介面規範

REST全稱是Representational State Transfer，中文意思是表述（編者注：通常譯為表徵性狀態轉移）。 它首次出現在2000年Roy Fielding的博士論文中。

RESTful是一種定義Web API介面的設計風格，尤其適用於前後端分離的應用模式中。

這種風格的理念認為後端開發任務就是提供資料的，對外提供的是資料資源的訪問介面，所以在定義介面時，客戶端訪問的URL路徑就表示這種要操作的資料資源。

事實上，我們可以使用任何一個框架都可以實現符合restful規範的API介面。

1.1 資料安全

• url連結一般都採用https協議進行傳輸

  注：採用https協議，可以提高資料互動過程中的安全性

1.2 介面特徵表現

• 用api關鍵字標識介面url：

  • https://api.baidu.com
  • https://www.baidu.com/api

  注：看到api字眼，就代表該請求url連結是完成前後臺數據互動的

1.3 多資料版本共存

• 在url連結中標識資料版本

  • https://api.baidu.com/v1
  • https://api.baidu.com/v2

  注：url連結中的v1、v2就是不同資料版本的體現（只有在一種資料資源有多版本情況下）

1.4 資料即是資源，均使用名詞（可複數）

• 介面一般都是完成前後臺數據的互動，互動的資料我們稱之為資源

  • https://api.baidu.com/users
  • https://api.baidu.com/books
  • https://api.baidu.com/book

  注：一般提倡用資源的複數形式，在url連結中獎勵不要出現操作資源的動詞，錯誤示範：https://api.baidu.com/delete-user

• 特殊的介面可以出現動詞，因為這些介面一般沒有一個明確的資源，或是動詞就是介面的核心含義

  • https://api.baidu.com/place/search
  • https://api.baidu.com/login

1.5 資源操作由請求方式決定（method）

• 操作資源一般都會涉及到增刪改查，我們提供請求方式來標識增刪改查動作
  • https://api.baidu.com/books
    - get請求：獲取所有書
  • https://api.baidu.com/books/1 - get請求：獲取主鍵為1的書
  • https://api.baidu.com/books - post請求：新增一本書書
  • https://api.baidu.com/books/1 - put請求：整體修改主鍵為1的書
  • https://api.baidu.com/books/1 - patch請求：區域性修改主鍵為1的書
  • https://api.baidu.com/books/1 - delete請求：刪除主鍵為1的書

1.6 過濾，通過在url上傳參的形式傳遞搜尋條件

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

1.7 響應狀態碼

1.7.1 正常響應

• 響應狀態碼2xx
  • 200：常規請求
  • 201：建立成功

1.7.2 重定向響應

• 響應狀態碼3xx
  • 301：永久重定向
  • 302：暫時重定向

1.7.3 客戶端異常

• 響應狀態碼4xx
  • 403：請求無許可權
  • 404：請求路徑不存在
  • 405：請求方法不存在

1.7.4 伺服器異常

• 響應狀態碼5xx
  • 500：伺服器異常

1.8 錯誤處理，應返回錯誤資訊，error當做key

{
    error: "無許可權操作"
}

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

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

1.10 需要url請求的資源需要訪問資源的請求連結

# Hypermedia API，RESTful API最好做到Hypermedia，即返回結果中提供連結，連向其他API方法，使得使用者不查文件，也知道下一步應該做什麼
{
  	"status": 0,
  	"msg": "ok",
  	"results":[
        {
            "name":"肯德基(羅餐廳)",
            "img": "https://image.baidu.com/kfc/001.png"
        }
      	...
		]
}