轉載：https://www.jianshu.com/p/ae36184e9925
1.Web應用模式，
在開發Web應用中，有兩種模式：
1.1前段后端不分離（耦合度高，適合純網頁的應用！）
在前后端不分離的應用模式中，前端頁面看到的效果都是由后端控制，由后端渲染頁面或重定向，也就是后端需要控制前端的展示，前端與后端的耦合度很高。
應用場景分析：
這種應用模式比較適合純網頁應用，但是當后端對接App時，App可能並不需要后端返回一個HTML網頁，而僅僅是數據本身，所以后端原本返回網頁的接口不再適用於前端App應用，為了對接App后端還需再開發一套接口。
1.2前段后端分離（耦合度低，前端通過訪問接口來對數據進行增刪改查）
在前后端分離的應用模式中，后端僅返回前端所需的數據，不再渲染HTML頁面，不再控制前端的效果。至於前端用戶看到什么效果，從后端請求的數據如何加載到前端中，都由前端自己決定，網頁有網頁的處理方式，App有App的處理方式，但無論哪種前端，所需的數據基本相同，后端僅需開發一套邏輯對外提供數據即可。
在前后端分離的應用模式中 ，前端與后端的耦合度相對較低。
在前后端分離的應用模式中，我們通常將后端開發的每個視圖都稱為一個接口，或者API，前端通過訪問接口來對數據進行增刪改查。
- RESTful設計方法
2.1域名
應該盡量將API部署在專用域名之下。
https://api.example.com
如果確定API很簡單，不會有進一步擴展，可以考慮放在主域名下。
2.2版本
應該將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
2.3路徑
路徑又稱"終點"（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
2.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：刪除某個指定動物園的指定動物
2.5 過濾信息
如果記錄數量很多，服務器不可能都將它們返回給用戶。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 的含義是相同的。
2.6 狀態嗎
服務器向用戶返回的狀態碼和提示信息，常見的有以下一些（方括號中是該狀態碼對應的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 - [*]：服務器發生錯誤，用戶將無法判斷發出的請求是否成功。
狀態碼的完全列表參見這里或這里。
2.7錯誤處理
如果狀態碼是4xx，服務器就應該向用戶返回出錯信息。一般來說，返回的信息中將error作為鍵名，出錯信息作為鍵值即可。
{ error: "Invalid API key" }
2.8返回結果
針對不同操作，服務器向用戶返回的結果應該符合以下規范。
GET /collection：返回資源對象的列表（數組）
GET /collection/resource：返回單個資源對象
POST /collection：返回新生成的資源對象
PUT /collection/resource：返回完整的資源對象
PATCH /collection/resource：返回完整的資源對象
DELETE /collection/resource：返回一個空文檔
2.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。
3.使用Django開發REST接口
我們以在Django框架中使用的圖書英雄案例來寫一套支持圖書數據增刪改查的REST API接口，來理解REST API的開發。
在此案例中，前后端均發送JSON格式數據。
views.py
from datetime import datetime class BooksAPIVIew(View): """ 查詢所有圖書、增加圖書 """ def get(self, request): """ 查詢所有圖書 路由：GET /books/ """ queryset = BookInfo.objects.all() book_list = [] 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) def post(self, request): """ 新增圖書 路由：POST /books/ """ json_bytes = request.body json_str = json_bytes.decode() book_dict = json.loads(json_str) # 此處詳細的校驗參數省略 book = BookInfo.objects.create( btitle=book_dict.get('btitle'), bpub_date=datetime.strptime(book_dict.get('bpub_date'), '%Y-%m-%d').date() ) return JsonResponse({ '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 '' }, status=201) class BookAPIView(View): def get(self, request, pk): """ 獲取單個圖書信息 路由： GET /books/<pk>/ """ try: book = BookInfo.objects.get(pk=pk) except BookInfo.DoesNotExist: return HttpResponse(status=404) return JsonResponse({ '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 '' }) def put(self, request, pk): """ 修改圖書信息 路由： PUT /books/<pk> """ try: book = BookInfo.objects.get(pk=pk) except BookInfo.DoesNotExist: return HttpResponse(status=404) json_bytes = request.body json_str = json_bytes.decode() book_dict = json.loads(json_str) # 此處詳細的校驗參數省略 book.btitle = book_dict.get('btitle') book.bpub_date = datetime.strptime(book_dict.get('bpub_date'), '%Y-%m-%d').date() book.save() return JsonResponse({ '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 '' }) def delete(self, request, pk): """ 刪除圖書 路由： DELETE /books/<pk>/ """ try: book = BookInfo.objects.get(pk=pk) except BookInfo.DoesNotExist: return HttpResponse(status=404) book.delete() return HttpResponse(status=204)
urls.py
urlpatterns = [ url(r'^books/$', views.BooksAPIVIew.as_view()), url(r'^books/(?P<pk>\d+)/$', views.BookAPIView.as_view()) ] 測試 使用Postman測試上述接口 1） 獲取所有圖書數據 GET 方式訪問 http://127.0.0.1:8000/books/， 返回狀態碼200，數據如下 [ { "id": 1, "btitle": "射雕英雄傳", "bpub_date": "1980-05-01", "bread": 12, "bcomment": 34, "image": "" }, { "id": 2, "btitle": "天龍八部", "bpub_date": "1986-07-24", "bread": 36, "bcomment": 40, "image": "" }, { "id": 3, "btitle": "笑傲江湖", "bpub_date": "1995-12-24", "bread": 20, "bcomment": 80, "image": "" }, { "id": 4, "btitle": "雪山飛狐", "bpub_date": "1987-11-11", "bread": 58, "bcomment": 24, "image": "" }, { "id": 5, "btitle": "西游記", "bpub_date": "1988-01-01", "bread": 10, "bcomment": 10, "image": "booktest/xiyouji.png" }, { "id": 6, "btitle": "水滸傳", "bpub_date": "1992-01-01", "bread": 10, "bcomment": 11, "image": "" }, { "id": 7, "btitle": "紅樓夢", "bpub_date": "1990-01-01", "bread": 0, "bcomment": 0, "image": "" } ]
2）獲取單一圖書數據
GET 訪問 http://127.0.0.1:8000/books/5/ ，返回狀態碼200， 數據如下
{ "id": 5, "btitle": "西游記", "bpub_date": "1988-01-01", "bread": 10, "bcomment": 10, "image": "booktest/xiyouji.png" }
GET 訪問http://127.0.0.1:8000/books/100/，返回狀態碼404
3）新增圖書數據
POST 訪問http://127.0.0.1:8000/books/，發送JSON數據：
{ "btitle": "三國演義", "bpub_date": "1990-02-03" } 返回狀態碼201，數據如下 { "id": 8, "btitle": "三國演義", "bpub_date": "1990-02-03", "bread": 0, "bcomment": 0, "image": "" }
4）修改圖書數據
PUT 訪問http://127.0.0.1:8000/books/8/，發送JSON數據：
{ "btitle": "三國演義（第二版）", "bpub_date": "1990-02-03" } 返回狀態碼200，數據如下 { "id": 8, "btitle": "三國演義（第二版）", "bpub_date": "1990-02-03", "bread": 0, "bcomment": 0, "image": "" }
5）刪除圖書數據
DELETE 訪問http://127.0.0.1:8000/books/8/，返回204狀態碼
4.明確REST接口開發的核心任務
在開發REST API接口時，視圖中做的最主要的三件事：
將請求的數據（如JSON格式）轉換為模型類對象
操作數據庫
將模型類對象轉換為響應的數據（如JSON格式）
5.序列化 Serialization
我們可以將序列化；理解為：
將程序中的一個數據結構類型轉換為其他格式（字典、JSON、XML等），例如將Django中的模型類對象轉換為JSON字符串，這個轉換過程我們稱為序列化。
如：
queryset = BookInfo.objects.all() book_list = [] # 序列化 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)
反之，將其他格式（字典、JSON、XML等）轉換為程序中的數據，例如將JSON字符串轉換為Django中的模型類對象，這個過程我們稱為反序列化。
如：
json_bytes = request.body json_str = json_bytes.decode() # 反序列化 book_dict = json.loads(json_str) book = BookInfo.objects.create( btitle=book_dict.get('btitle'), bpub_date=datetime.strptime(book_dict.get('bpub_date'), '%Y-%m-%d').date() )
我們可以看到，在開發REST API時，視圖中要頻繁的進行序列化與反序列化的編寫。
總結
在開發REST API接口時，我們在視圖中需要做的最核心的事是：
將數據庫數據序列化為前端所需要的格式，並返回；
將前端發送的數據反序列化為模型類對象，並保存到數據庫中。
-
Django REST framework 簡介
在序列化與反序列化時，雖然操作的數據不盡相同，但是執行的過程卻是相似的，也就是說這部分代碼是可以復用簡化編寫的。
開發REST API的視圖中，雖然每個視圖具體操作的數據不同，但增、刪、改、查的實現流程基本套路化，所以這部分代碼也是可以復用簡化編寫的：
增：校驗請求數據 -> 執行反序列化過程 -> 保存數據庫 -> 將保存的對象序列化並返回
刪：判斷要刪除的數據是否存在 -> 執行數據庫刪除
改：判斷要修改的數據是否存在 -> 校驗請求的數據 -> 執行反序列化過程 -> 保存數據庫 -> 將保存的對象序列化並返回
查：查詢數據庫 -> 將數據序列化並返回
Django REST framework可以幫助我們簡化上述兩部分的代碼編寫，大大提高REST API的開發速度。
7.認識 Django REST framework 框架
Django REST framework 框架是一個用於構建Web API 的強大而又靈活的工具。
通常簡稱為DRF框架 或 REST framework。
DRF框架是建立在Django框架基礎之上，由Tom Christie大牛二次開發的開源項目。
提供了定義序列化器Serializer的方法，可以快速根據 Django ORM 或者其它庫自動序列化/反序列化；
提供了豐富的類視圖、Mixin擴展類，簡化視圖的編寫；
豐富的定制層級：函數視圖、類視圖、視圖集合到自動生成 API，滿足各種需要；
多種身份認證和權限認證方式的支持；
內置了限流系統；
直觀的 API web 界面；
可擴展性，插件豐富