REST Framework接口規范

一 、發展及其背景介紹

網絡應用程序，分為前端和后端兩個部分。當前的發展趨勢，就是前端設備層出不窮（手機、平板、桌面電腦、其他專用設備…）。因此，必須有一種統一的機制，方便不同的前端設備與后端進行通信。這導致API構架的流行，甚至出現APIFirst的設計思想。RESTful API是目前比較成熟的一套互聯網應用程序的API設計理論。

REST（Representational State Transfer）表述性狀態轉換，REST指的是一組架構約束條件和原則。 如果一個架構符合REST的約束條件和原則，我們就稱它為RESTful架構。REST本身並沒有創造新的技術、組件或服務，而隱藏在RESTful背后的理念就是使用Web的現有特征和能力， 更好地使用現有Web標准中的一些准則和約束。雖然REST本身受Web技術的影響很深， 但是理論上REST架構風格並不是綁定在HTTP上，只不過目前HTTP是唯一與REST相關的實例。

二 、接口小瞥

Web接口訪問測試

• 請求工具 : Postman
• 接口 : url鏈接，通過向鏈接發生不同的類型請求與數據得到相應的響應數據
• 請求鏈接地址 : http://127.0.0.1:8888/test/
• 請求接口API : https://api.map.baidu.com/place/v2/search

ak: 6E823f587c95f0148c19993539b99295
region: 上海
query: 肯德基
output: json

三 、RESTful規范

3.1 域名

1. 訪問接口應盡量將API部署在專用域名之下。

https://api.example.com

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

https://www.example.org/api/

3.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字段中進行區分（參見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

3.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

3.4 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：刪除某個指定動物園的指定動物

3.5 過濾信息（Filtering）

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

下面是一些常見的參數。query_string 查詢字符串,地址欄后面問號后面的數據,格式: name=xx&sss=xxx

完整的URL地址格式：
協議://域名(IP):端口號/路徑?查詢字符串#錨點

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

3.6 狀態碼（Status Codes）

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

服務器向用戶返回的狀態碼和提示信息，常見的有以下一些（方括號中是該狀態碼對應的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 - [*]：服務器發生錯誤，用戶將無法判斷發出的請求是否成功。

507 數據存儲出錯，往往數據庫操作錯誤出錯，服務器就返回這個

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

3.7 錯誤處理（Error handling）

如果狀態碼是4xx，服務器就應該向用戶返回出錯信息。一般來說，返回的信息中將error作為鍵名，出錯信息作為鍵值即可。

{
    error: "Invalid API key"
}

3.8 返回結果

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

• GET /collection：返回資源對象的列表（數組）
• GET /collection/ID：返回單個資源對象(json)
• POST /collection：返回新生成的資源對象(json)
• PUT /collection/ID：返回完整的資源對象(json)
• DELETE /collection/ID：返回一個空文檔(空字符串)

3.9 超媒體（Hypermedia API）

RESTful API最好做到``Hypermedia`（即返回結果中提供鏈接，連向其他API方法），使得用戶不查文檔，也知道下一步應該做什么。

比如，``Github的API就是這種設計，訪問[api.github.com](https://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"
}

上面代碼表示，服務器給出了提示信息，以及文檔的網址。

3.10 其他

服務器返回的數據格式，應該盡量使用JSON，避免使用XML。

XML是W3C為了替換HTML研發出來的，但是現在很明顯失敗了。

1. xml 配置文件

<xml version="1.0" charset="utf-8">
	<name>張三</name>
  <sex>男</sex>
  <age>18</age>
</xml>

2. json配置文件

{
  “name”:"張三",
  "sex":"男",
  "age":18
}

四 、DRF書寫簡易的RESTFul接口

# 路由層url.py

from app import views
urlpatterns = [
    url(r'^admin/', admin.site.urls),
    url(r'^cbv/', views.CBVTest.as_view()),
    url(r'^books/', views.books),
    url(r'^book/(?P<id>\d+)/', views.book),
]

# 視圖層view.py

from django.http import JsonResponse
book_list = [{'id': 1, 'name': '紅樓夢'}, {'id': 2, 'name': '水滸傳'}]

def books(request):
    if request.method == "GET":
        if 'ak' not in request.GET:
            return JsonResponse({
                'status': '101',
                'msg': 'ak不存在'
            }, json_dumps_params={'ensure_ascii': False})
        ak = request.GET.get('ak')
        if ak != '123abc':
            return JsonResponse({
                'status': '200',
                'msg': 'ak非法'
            }, json_dumps_params={'ensure_ascii': False})
        return JsonResponse({
                'status': '0',
                'msg': 'ok',
                'results': book_list
            }, json_dumps_params={'ensure_ascii': False})
    if request.method == 'POST':
        name = request.POST.get('name')
        id = len(book_list) + 1
        book = {'id': id, 'name': name}
        book_list.append(book)
        return JsonResponse({
            'status': '0',
            'msg': 'ok',
            'results': book
        }, json_dumps_params={'ensure_ascii': False})

五 、標准接口文檔小瞥