本篇導航: RESTful RESTful API設計 基於django實現 基於Django Rest Framework框架實現 一、RESTful REST與技術無關,代表的是一種軟體架構風格,REST是Representational State Transfer的簡稱,中文翻譯為“表徵狀態 ...
本篇導航:
REST與技術無關,代表的是一種軟體架構風格,REST是Representational State Transfer的簡稱,中文翻譯為“表徵狀態轉移”
REST從資源的角度類審視整個網路,它將分佈在網路中某個節點的資源通過URL進行標識,客戶端應用通過URL來獲取資源的表徵,獲得這些表徵致使這些應用轉變狀態
REST與技術無關,代表的是一種軟體架構風格,REST是Representational State Transfer的簡稱,中文翻譯為“表徵狀態轉移”
所有的數據,不過是通過網路獲取的還是操作(增刪改查)的數據,都是資源,將一切數據視為資源是REST區別與其他架構風格的最本質屬性
對於REST這種面向資源的架構風格,有人提出一種全新的結構理念,即:面向資源架構(ROA:Resource Oriented Architecture)
網路應用程式,分為前端和後端兩個部分。當前的發展趨勢,就是前端設備層出不窮(手機、平板、桌面電腦、其他專用設備......)。
因此,必須有一種統一的機制,方便不同的前端設備與後端進行通信。這導致API構架的流行,甚至出現"API First"的設計思想。RESTful API是目前比較成熟的一套互聯網應用程式的API設計理論。
API就是介面,提供的url。介面有兩個用途:
- 為別人提供服務
- 前後端分離,一個寫vue,一個寫後端,他們之間都是通過ajax請求
1、協議
API與用戶的通信協議,總是使用HTTPs協議。
2、功能變數名稱
https://api.example.com 儘量將API部署在專用功能變數名稱(會存在跨域問題)
https://example.org/api/ API很簡單
3、版本(Versioning)
應該將API的版本號放入URL。
https://api.example.com/v1/
另一種做法是,將版本號放在HTTP頭信息中,但不如放入URL方便和直觀。Github採用這種做法。
4、路徑(Endpoint)
路徑又稱"終點"(endpoint),表示API的具體網址。
在RESTful架構中,每個網址代表一種資源(resource),所以網址中不能有動詞,只能有名詞,而且所用的名詞往往與資料庫的表格名對應。一般來說,資料庫中的表都是同種記錄的"集合"(collection),所以API中的名詞也應該使用複數。
舉例來說,有一個API提供動物園(zoo)的信息,還包括各種動物和雇員的信息,則它的路徑應該設計成下麵這樣。
https://api.example.com/v1/zoos https://api.example.com/v1/animals https://api.example.com/v1/employees
5、HTTP動詞(method)
對於資源的具體操作類型,由HTTP動詞表示。
常用的HTTP動詞有下麵五個(括弧里是對應的SQL命令)。
GET(SELECT):從伺服器取出資源(一項或多項)。
POST(CREATE):在伺服器新建一個資源。
PUT(UPDATE):在伺服器更新資源(客戶端提供改變後的完整資源)。
PATCH(UPDATE):在伺服器更新資源(客戶端提供改變的屬性)。
DELETE(DELETE):從伺服器刪除資源。
還有兩個不常用的HTTP動詞。
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:刪除某個指定動物園的指定動物
6、過濾信息(Filtering)
如果記錄數量很多,伺服器不可能都將它們返回給用戶。API應該提供參數,過濾返回結果。
下麵是一些常見的參數。
?limit=10:指定返回記錄的數量 ?offset=10:指定返回記錄的開始位置。 ?page=2&per_page=100:指定第幾頁,以及每頁的記錄數。 ?sortby=name&order=asc:指定返回結果按照哪個屬性排序,以及排序順序。 ?animal_type_id=1:指定篩選條件
參數的設計允許存在冗餘,即允許API路徑和URL參數偶爾有重覆。比如,GET /zoo/ID/animals 與 GET /animals?zoo_id=ID 的含義是相同的。
7、狀態碼(Status Codes)
伺服器向用戶返回的狀態碼和提示信息,常見的有以下一些(方括弧中是該狀態碼對應的HTTP動詞)。
200 OK - [GET]:伺服器成功返回用戶請求的數據,該操作是冪等的(Idempotent)。 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 - [*]:伺服器發生錯誤,用戶將無法判斷發出的請求是否成功。
狀態碼的完全列表見:http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
8、錯誤處理(Error handling)
如果狀態碼是4xx,就應該向用戶返回出錯信息。一般來說,返回的信息中將error作為鍵名,出錯信息作為鍵值即可。
{ error: "Invalid API key" }
9、返回結果
針對不同操作,伺服器向用戶返回的結果應該符合以下規範。
GET /collection:返回資源對象的列表(數組) GET /collection/resource:返回單個資源對象 POST /collection:返回新生成的資源對象 PUT /collection/resource:返回完整的資源對象 PATCH /collection/resource:返回完整的資源對象 DELETE /collection/resource:返回一個空文檔
10、Hypermedia API
RESTful API最好做到Hypermedia,即返回結果中提供鏈接,連向其他API方法,使得用戶不查文檔,也知道下一步應該做什麼。
比如,當用戶向api.example.com的根目錄發出請求,會得到這樣一個文檔。
{"link": { "rel": "collection https://www.example.com/zoos", "href": "https://api.example.com/zoos", "title": "List of zoos", "type": "application/vnd.yourformat+json" }}
11、其他
1)API的身份認證應該使用OAuth 2.0框架。
2)伺服器返回的數據格式,應該儘量使用JSON,避免使用XML。
1、FBV模式
全局url
from django.contrib import admin from django.conf.urls import url, include urlpatterns = [ url('admin/', admin.site.urls), url('api/', include('api.urls')) ]
api.urls
from api import views from django.conf.urls import url urlpatterns = [ url('^users/', views.users), url('^user/(\d+)', views.user), ]
views
from django.shortcuts import render,HttpResponse # Create your views here. import json def users(request): response = {'code':1000,'data':None} #code用來表示狀態,比如1000代表成功,1001代表 response['data'] = [ {'name':'haiyan','age':22}, {'name':'haidong','age':10}, {'name':'haixiyu','age':11}, ] return HttpResponse(json.dumps(response)) #返回多條數據 def user(request,pk): if request.method =='GET': return HttpResponse(json.dumps({'name':'haiyan','age':11})) #返回一條數據 elif request.method =='POST': return HttpResponse(json.dumps({'code':1111})) #返回一條數據 elif request.method =='PUT': pass elif request.method =='DELETE': pass
2、CBV模式
api.urls
from api import views from django.conf.urls import url urlpatterns = [ url('^users/', views.UsersView.as_view()), url('^user/', views.UserView.as_view()), ]
views
from django.views import View class UsersView(View): def get(self,request): response = {'code':1000,'data':None} response['data'] = [ {'name': 'haiyan', 'age': 22}, {'name': 'haidong', 'age': 10}, {'name': 'haixiyu', 'age': 11}, ] return HttpResponse(json.dumps(response),stutas=200) class UserView(View): def get(self,request,pk): return HttpResponse(json.dumps({'name':'haiyan','age':11})) #返回一條數據 def post(self,request,pk): return HttpResponse(json.dumps({'code':1111})) #返回一條數據 def put(self,request,pk): pass def delete(self,request,pk): pass
基於django實現的API許多功能都需要我們自己開發,這時候Django Rest Framework框架就給我們提供了方便。
url.py
from django.conf.urls import url, include from web.views.s1_api import TestView urlpatterns = [ url(r'^test/', TestView.as_view()), ]
views.py
from rest_framework.views import APIView from rest_framework.response import Response class TestView(APIView): def dispatch(self, request, *args, **kwargs): """ 請求到來之後,都要執行dispatch方法,dispatch方法根據請求方式不同觸發 get/post/put等方法 註意:APIView中的dispatch方法有好多好多的功能 """ return super().dispatch(request, *args, **kwargs) def get(self, request, *args, **kwargs): return Response('GET請求,響應內容') def post(self, request, *args, **kwargs): return Response('POST請求,響應內容') def put(self, request, *args, **kwargs): return Response('PUT請求,響應內容')
上述是rest framework框架基本流程,重要的功能是在APIView的dispatch中觸發。
首先沒有Django rest_Framework框架用django也是可以做出來的,只不過它為我們提供一些API常用的功能,比如:(認證,許可權,限流,有了這些我們只需要寫個類已配置,它就能當都市圖用,還能全局配置,如果自己寫還得寫中間件,寫裝飾器來實現,通過Django rest_Framework框架,他已經把規則寫好,只需要寫類,只需實現方法,返回值就可以)實現了一部分功能。