引入Django REST framework在本章中蘸拔，我們要大家介紹為什么學(xué)習(xí)Django REST framework，它能幫助我們做哪些事情脓诡。
案例思路：我們從分析現(xiàn)在流行的前后端分離Web應(yīng)用模式說(shuō)起烟零，然后介紹如何設(shè)計(jì)REST API，通過(guò)使用Django來(lái)實(shí)現(xiàn)一個(gè)REST API為例暴备，明確后端開(kāi)發(fā)REST API要做的最核心工作悠瞬，然后介紹Django REST framework能幫助我們簡(jiǎn)化開(kāi)發(fā)REST API的工作。
Web應(yīng)用模式
在開(kāi)發(fā)Web應(yīng)用中，有兩種應(yīng)用模式：
前后端不分離
前后端分離
1 前后端不分離
在前后端不分離的應(yīng)用模式中浅妆，前端頁(yè)面看到的效果都是由后端控制望迎，由后端渲染頁(yè)面或重定向，也就是后端需要控制前端的展示凌外，前端與后端的耦合度很高辩尊。
這種應(yīng)用模式比較適合純網(wǎng)頁(yè)應(yīng)用，但是當(dāng)后端對(duì)接App時(shí)康辑，App可能并不需要后端返回一個(gè)HTML網(wǎng)頁(yè)摄欲，而僅僅是數(shù)據(jù)本身，所以后端原本返回網(wǎng)頁(yè)的接口不再適用于前端App應(yīng)用疮薇，為了對(duì)接App后端還需再開(kāi)發(fā)一套接口胸墙。
2 前后端分離
在前后端分離的應(yīng)用模式中，后端僅返回前端所需的數(shù)據(jù)按咒，不再渲染HTML頁(yè)面迟隅，不再控制前端的效果。至于前端用戶看到什么效果励七，從后端請(qǐng)求的數(shù)據(jù)如何加載到前端中智袭，都由前端自己決定，網(wǎng)頁(yè)有網(wǎng)頁(yè)的處理方式呀伙，App有App的處理方式补履，但無(wú)論哪種前端，所需的數(shù)據(jù)基本相同剿另，后端僅需開(kāi)發(fā)一套邏輯對(duì)外提供數(shù)據(jù)即可箫锤。
在前后端分離的應(yīng)用模式中 ，前端與后端的耦合度相對(duì)較低雨女。
在前后端分離的應(yīng)用模式中谚攒，我們通常將后端開(kāi)發(fā)的每個(gè)視圖都稱為一個(gè)接口，或者API氛堕，前端通過(guò)訪問(wèn)接口來(lái)對(duì)數(shù)據(jù)進(jìn)行增刪改查馏臭。
認(rèn)識(shí)RESTful
在前后端分離的應(yīng)用模式里，后端API接口如何定義讼稚？
對(duì)于接口的請(qǐng)求方式與路徑括儒，每個(gè)后端開(kāi)發(fā)人員可能都有自己的定義方式，風(fēng)格迥異锐想。
是否存在一種統(tǒng)一的定義方式帮寻，被廣大開(kāi)發(fā)人員接受認(rèn)可的方式呢？
這就是被普遍采用的API的RESTful設(shè)計(jì)風(fēng)格赠摇。
例如對(duì)于后端數(shù)據(jù)庫(kù)中保存了商品的信息固逗，前端可能需要對(duì)商品數(shù)據(jù)進(jìn)行增刪改查浅蚪，那相應(yīng)的每個(gè)操作后端都需要提供一個(gè)API接口：
起源
REST這個(gè)詞，是Roy Thomas Fielding在他2000年的博士論文中提出的烫罩。
Fielding是一個(gè)非常重要的人惜傲，他是HTTP協(xié)議（1.0版和1.1版）的主要設(shè)計(jì)者、Apache服務(wù)器軟件的作者之一贝攒、Apache基金會(huì)的第一任主席盗誊。所以，他的這篇論文一經(jīng)發(fā)表饿这，就引起了關(guān)注浊伙，并且立即對(duì)互聯(lián)網(wǎng)開(kāi)發(fā)產(chǎn)生了深遠(yuǎn)的影響。
說(shuō)明
RESTful是一種開(kāi)發(fā)理念长捧。REST是設(shè)計(jì)風(fēng)格而不是標(biāo)準(zhǔn)嚣鄙。
公司中的后端程序員在定義后端的接口時(shí)，可以選擇是否遵守這種設(shè)計(jì)風(fēng)格串结。
RESTful設(shè)計(jì)風(fēng)格的API哑子，每種請(qǐng)求方法，都對(duì)應(yīng)后端一種數(shù)據(jù)庫(kù)操作肌割。
RESTful設(shè)計(jì)方法
1. 域名
應(yīng)該盡量將API部署在專用域名之下卧蜓。
https://api.example.com
如果確定API很簡(jiǎn)單，不會(huì)有進(jìn)一步擴(kuò)展把敞，可以考慮放在主域名下弥奸。
https://example.org/api/
2. 版本（Versioning）
應(yīng)該將API的版本號(hào)放入U(xiǎn)RL。
http://www.example.com/app/1.0/foo
http://www.example.com/app/1.1/foo
http://www.example.com/app/2.0/foo
另一種做法是奋早，將版本號(hào)放在HTTP頭信息中盛霎，但不如放入U(xiǎn)RL方便和直觀。Github采用這種做法耽装。
因?yàn)椴煌陌姹痉哒ǎ梢岳斫獬赏环N資源的不同表現(xiàn)形式，所以應(yīng)該采用同一個(gè)URL掉奄。版本號(hào)可以在HTTP請(qǐng)求頭信息的Accept字段中進(jìn)行區(qū)分（參見(jiàn)Versioning REST Services）：
Accept:vnd.example-com.foo+json; version=1.0Accept:vnd.example-com.foo+json; version=1.1Accept:vnd.example-com.foo+json;version=2.0
3. 路徑（Endpoint）
路徑又稱"終點(diǎn)"（endpoint）规个，表示API的具體網(wǎng)址，每個(gè)網(wǎng)址代表一種資源（resource）
(1) 資源作為網(wǎng)址姓建，只能有名詞诞仓，不能有動(dòng)詞，而且所用的名詞往往與數(shù)據(jù)庫(kù)的表名對(duì)應(yīng)速兔。
舉例來(lái)說(shuō)狂芋，以下是不好的例子:
/getProducts
/listOrders
/retreiveClientByOrder?orderId=1
對(duì)于一個(gè)簡(jiǎn)潔結(jié)構(gòu)，你應(yīng)該始終用名詞憨栽。 此外，利用的HTTP方法可以分離網(wǎng)址中的資源名稱的操作。
GET /products ：將返回所有產(chǎn)品清單
POST /products ：將產(chǎn)品新建到集合
GET /products/4 ：將獲取產(chǎn)品 4
PATCH（或）PUT /products/4 ：將更新產(chǎn)品 4
(2) API中的名詞應(yīng)該使用復(fù)數(shù)屑柔。無(wú)論子資源或者所有資源屡萤。
舉例來(lái)說(shuō)，獲取產(chǎn)品的API可以這樣定義
獲取單個(gè)產(chǎn)品：http://127.0.0.1:8080/AppName/rest/products/1
獲取所有產(chǎn)品: http://127.0.0.1:8080/AppName/rest/products
3. HTTP動(dòng)詞
對(duì)于資源的具體操作類型掸宛，由HTTP動(dòng)詞表示死陆。
常用的HTTP動(dòng)詞有下面四個(gè)（括號(hào)里是對(duì)應(yīng)的SQL命令）。
GET（SELECT）：從服務(wù)器取出資源（一項(xiàng)或多項(xiàng)）唧瘾。
POST（CREATE）：在服務(wù)器新建一個(gè)資源措译。
PUT（UPDATE）：在服務(wù)器更新資源（客戶端提供改變后的完整資源）。
DELETE（DELETE）：從服務(wù)器刪除資源饰序。
還有三個(gè)不常用的HTTP動(dòng)詞领虹。
PATCH（UPDATE）：在服務(wù)器更新(更新)資源（客戶端提供改變的屬性）。
HEAD：獲取資源的元數(shù)據(jù)求豫。
OPTIONS：獲取信息塌衰，關(guān)于資源的哪些屬性是客戶端可以改變的。
下面是一些例子蝠嘉。
GET /zoos：列出所有動(dòng)物園
POST /zoos：新建一個(gè)動(dòng)物園（上傳文件）
GET /zoos/ID：獲取某個(gè)指定動(dòng)物園的信息
PUT /zoos/ID：更新某個(gè)指定動(dòng)物園的信息（提供該動(dòng)物園的全部信息）
PATCH /zoos/ID：更新某個(gè)指定動(dòng)物園的信息（提供該動(dòng)物園的部分信息）
DELETE /zoos/ID：刪除某個(gè)動(dòng)物園
GET /zoos/ID/animals：列出某個(gè)指定動(dòng)物園的所有動(dòng)物
DELETE /zoos/ID/animals/ID：刪除某個(gè)指定動(dòng)物園的指定動(dòng)物
4. 過(guò)濾信息（Filtering）
如果記錄數(shù)量很多最疆，服務(wù)器不可能都將它們返回給用戶。API應(yīng)該提供參數(shù)蚤告，過(guò)濾返回結(jié)果努酸。
下面是一些常見(jiàn)的參數(shù)。
?limit=10：指定返回記錄的數(shù)量
?offset=10：指定返回記錄的開(kāi)始位置杜恰。
?page=2&per_page=100：指定第幾頁(yè)获诈，以及每頁(yè)的記錄數(shù)。
?sortby=name&order=asc：指定返回結(jié)果按照哪個(gè)屬性排序箫章，以及排序順序烙荷。
?animal_type_id=1：指定篩選條件
參數(shù)的設(shè)計(jì)允許存在冗余，即允許API路徑和URL參數(shù)偶爾有重復(fù)檬寂。比如终抽，GET /zoos/ID/animals 與 GET /animals?zoo_id=ID 的含義是相同的。
5. 狀態(tài)碼（Status Codes）
服務(wù)器向用戶返回的狀態(tài)碼和提示信息桶至，常見(jiàn)的有以下一些（方括號(hào)中是該狀態(tài)碼對(duì)應(yīng)的HTTP動(dòng)詞）昼伴。
200 OK - [GET]：服務(wù)器成功返回用戶請(qǐng)求的數(shù)據(jù)
201 CREATED - [POST/PUT/PATCH]：用戶新建或修改數(shù)據(jù)成功。
202 Accepted - [*]：表示一個(gè)請(qǐng)求已經(jīng)進(jìn)入后臺(tái)排隊(duì)（異步任務(wù)）
204 NO CONTENT - [DELETE]：用戶刪除數(shù)據(jù)成功镣屹。
400 INVALID REQUEST - [POST/PUT/PATCH]：用戶發(fā)出的請(qǐng)求有錯(cuò)誤圃郊，服務(wù)器沒(méi)有進(jìn)行新建或修改數(shù)據(jù)的操作
401 Unauthorized - [*]：表示用戶沒(méi)有權(quán)限（令牌、用戶名女蜈、密碼錯(cuò)誤）持舆。
403 Forbidden - [*] 表示用戶得到授權(quán)（與401錯(cuò)誤相對(duì)）色瘩，但是訪問(wèn)是被禁止的。
404 NOT FOUND - [*]：用戶發(fā)出的請(qǐng)求針對(duì)的是不存在的記錄逸寓，服務(wù)器沒(méi)有進(jìn)行操作居兆，該操作是冪等的。
406 Not Acceptable - [GET]：用戶請(qǐng)求的格式不可得（比如用戶請(qǐng)求JSON格式竹伸，但是只有XML格式）泥栖。
410 Gone -[GET]：用戶請(qǐng)求的資源被永久刪除，且不會(huì)再得到的勋篓。
422 Unprocesable entity - [POST/PUT/PATCH] 當(dāng)創(chuàng)建一個(gè)對(duì)象時(shí)吧享，發(fā)生一個(gè)驗(yàn)證錯(cuò)誤。
500 INTERNAL SERVER ERROR - [*]：服務(wù)器發(fā)生錯(cuò)誤譬嚣，用戶將無(wú)法判斷發(fā)出的請(qǐng)求是否成功钢颂。
6. 錯(cuò)誤處理（Error handling）
如果狀態(tài)碼是4xx孤荣，服務(wù)器就應(yīng)該向用戶返回出錯(cuò)信息甸陌。一般來(lái)說(shuō)，返回的信息中將error作為鍵名盐股，出錯(cuò)信息作為鍵值即可钱豁。
{? ? error:"Invalid API key"}
8. 返回結(jié)果
針對(duì)不同操作，服務(wù)器向用戶返回的結(jié)果應(yīng)該符合以下規(guī)范疯汁。
GET /collection：返回資源對(duì)象的列表（數(shù)組）
GET /collection/resource：返回單個(gè)資源對(duì)象
POST /collection：返回新生成的資源對(duì)象
PUT /collection/resource：返回完整的資源對(duì)象
PATCH /collection/resource：返回完整的資源對(duì)象
DELETE /collection/resource：返回一個(gè)空文檔
8. 超媒體（Hypermedia API）
RESTful API最好做到Hypermedia（即返回結(jié)果中提供鏈接牲尺，連向其他API方法），使得用戶不查文檔幌蚊，也知道下一步應(yīng)該做什么谤碳。
比如，Github的API就是這種設(shè)計(jì)溢豆，訪問(wèn)api.github.com會(huì)得到一個(gè)所有可用API的網(wǎng)址列表蜒简。
{"current_user_url":"https://api.github.com/user","authorizations_url":"https://api.github.com/authorizations",// ...}
從上面可以看到，如果想獲取當(dāng)前用戶的信息漩仙，應(yīng)該去訪問(wèn)api.github.com/user搓茬，然后就得到了下面結(jié)果。
{"message":"Requires authentication","documentation_url":"https://developer.github.com/v3"}
上面代碼表示队他，服務(wù)器給出了提示信息卷仑，以及文檔的網(wǎng)址。
9. 其他
服務(wù)器返回的數(shù)據(jù)格式麸折，應(yīng)該盡量使用JSON锡凝，避免使用XML。
使用Django開(kāi)發(fā)REST 接口
我們以在Django框架中使用的圖書英雄案例來(lái)寫一套支持圖書數(shù)據(jù)增刪改查的REST API接口垢啼，來(lái)理解REST API的開(kāi)發(fā)窜锯。
在此案例中张肾，前后端均發(fā)送JSON格式數(shù)據(jù)。
# views.py
from datetime import datetime
class BooksAPIVIew(View):
? ?? ? ??"""
? ?? ?查詢所有圖書衬浑、增加圖書
? ????? """
? ?? ??defget(self, request):"""
? ?? ? 查詢所有圖書? ? ? ?
????路由：GET /books/ ? """
????queryset = BookInfo.objects.all()?
? ?? book_list = []
? ?? forbookinqueryset:
? ?? for book in queryset:?
? ?????? book_list.append({
? ?????????? 'id': book.id,
? ?????????? 'btitle': book.btitle,
? ?????????? 'bpub_date': book.bpub_date,
? ?????????? 'bread': book.bread,
? ?????????? 'bcomment': book.bcomment,
? ?????????? 'image': book.image.url if book.image else '' })
? ?????? return JsonResponse(book_list, safe=False)?
??
? ??
