7.8RESTful
7.8.1前後端分離介紹
（1）前後端不分離圖解
（2）前後端分離圖解
7.8.2爲什麼要學習DRF
（1）DRF可以幫助開發者快速的開發一個依託於Django的前後端分離的項目
（2）django可以實現前後端分離，但django開發前後端分離的項目週期長，django如果要遵守RESTful設計風格需要自己寫對應風格的路由
（3）DRF專門實現前後端分離，DRF開發前後端分離的週期短，默認遵守的是RESTful設計風格
7.8.3RESTful介紹
（1）在前後端分離的應用模式裏，後端API接口如何定義
需要一種規範和風格來約束後端程序員對接口的定義，RESTful就是用來約束後端程序員對接口的定義的一種風格
（2）REST，即：Representational State Transfer的縮寫。解釋爲：“具象狀態傳輸”或者“表現層狀態轉化”
（3）RESTful是一種開發理念
（4）RESTful架構
- 每一個URL代表一種資源；
- 客戶端和服務器之間，傳遞這種資源的某種表現層；
- 客戶端通過四個HTTP動詞，對服務器端資源進行操作，實現"表現層狀態轉化"。
7.8.4RESTful設計方法
(1) 域名
應該儘量將API部署在專用域名之下。
https://api.example.com
如果確定API很簡單，不會有進一步擴展，可以考慮放在主域名下。
https://example.org/api/
(2)版本（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字段中進行區分
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
（4）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：刪除某個指定動物園的指定動物
（5）過濾信息（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/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 - [*]：服務器發生錯誤，用戶將無法判斷髮出的請求是否成功。
（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。
7.8.5使用django定義REST接口（API）
（1）目的
爲了學習在沒有DRF的情況下，如何使用Django原生的形式實現前後端分離且遵守RESTful設計風格的項目
（2）REST接口路由說明
（3）提供所有記錄
（4）新增一條記錄
（5）提供指定id的記錄
（6）修改指定id的記錄
（7）刪除指定id的記錄
