一. 什么是RESTful
- REST與技術無關，代表的是一種軟件架構風格，REST是Representational State Transfer的簡稱，中文翻譯為“表征狀態轉移”
- REST從資源的角度類審視整個網絡，它將分布在網絡中某個節點的資源通過URL進行標識，客戶端應用通過URL來獲取資源的表征，獲得這些表征致使這些應用轉變狀態
- 所有的數據，不管是通過網絡獲取的還是操作數據庫獲得（增刪改查）的數據，都是資源，將一切數據視為資源是REST區別與其他架構風格的最本質屬性
- 對於REST這種面向資源的架構風格，有人提出一種全新的結構理念，即：面向資源架構（ROA：Resource Oriented Architecture）
- 對互聯網上的任意東西都視為資源，他認為一個url就是一個資源 比如：http://www.xxx.com/get_user/
二. 了解什么是API
1、什么是API？
答：API就是接口，提供的url。接口有兩個用途：
- - 為別人提供服務
- - 前后端分離，一個寫vue，一個寫后端，他們之間都是通過ajax請求
三、RESTful API設計
網絡應用程序，分為前端和后端兩個部分。當前的發展趨勢，就是前端設備層出不窮（手機、平板、桌面電腦、其他專用設備......）。
因此，必須有一種統一的機制，方便不同的前端設備與后端進行通信。這導致API構架的流行，甚至出現"API First"的設計思想。RESTful API是目前比較成熟的一套互聯網應用程序的API設計理論。
那么先來簡單了解一下
1、協議
API與用戶的通信協議，總是使用HTTPs協議。
2、域名
有兩種方式
方式一： 盡量將API部署在專用域名（會存在跨域問題）
https://api.example.com
方式二：如果確定API很簡單，不會有進一步擴展，可以考慮放在主域名下。
https://example.org/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動詞
對於資源的具體操作類型，由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 - [*]：服務器發生錯誤，用戶將無法判斷發出的請求是否成功。
狀態碼的完全列表參見這里。
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 超媒體API
RESTful API最好做到Hypermedia，即返回結果中提供鏈接，連向其他API方法，使得用戶不查文檔，也知道下一步應該做什么。
比如，當用戶向api.example.com的根目錄發出請求，會得到這樣一個文檔。
{"link": {
"rel": "collection https://www.example.com/zoos", #表示這個API與當前網址的關系（collection關系，並給出該collection的網址）
"href": "https://api.example.com/zoos", #API路徑
"title": "List of zoos", #API的標題
"type": "application/vnd.yourformat+json" #返回類型
}}
Hypermedia API的設計被稱為HATEOAS。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" }
四、基於Django實現API
方式一：FBV模式：
1 from django.contrib import admin 2 3 from django.conf.urls import url, include 4 from app01 import views 5 from app02 import views 6 7 urlpatterns = [ 8 url('admin/', admin.site.urls), 9 # path('hosts/',views.HostView.as_view()), 10 url('app02/', include('app02.urls')) 11 ]
1 from app02 import views 2 from django.conf.urls import url 3 urlpatterns = [ 4 url('^users/', views.users), 5 url('^user/(\d+)', views.user), 6 7 url('^users/', views.UsersView.as_view()), 8 url('^user/', views.UserView.as_view()), 9 ]
1 from django.shortcuts import render,HttpResponse 2 3 # Create your views here. 4 import json 5 6 def users(request): 7 response = {'code':1000,'data':None} #code用來表示狀態，比如1000代表成功，1001代表 8 response['data'] = [ 9 {'name':'haiyan','age':22}, 10 {'name':'haidong','age':10}, 11 {'name':'haixiyu','age':11}, 12 ] 13 return HttpResponse(json.dumps(response)) #返回多條數據 14 15 def user(request,pk): 16 if request.method =='GET': 17 return HttpResponse(json.dumps({'name':'haiyan','age':11})) #返回一條數據 18 elif request.method =='POST': 19 return HttpResponse(json.dumps({'code':1111})) #返回一條數據 20 elif request.method =='PUT': 21 pass 22 elif request.method =='DELETE': 23 pass
方式二：CBV模式
1 from app02 import views 2 from django.conf.urls import url 3 urlpatterns = [ 4 url('^users/', views.UsersView.as_view()), 5 url('^user/', views.UserView.as_view()), 6 ]
1 from django.views import View 2 class UsersView(View): 3 def get(self,request): 4 response = {'code':1000,'data':None} 5 response['data'] = [ 6 {'name': 'haiyan', 'age': 22}, 7 {'name': 'haidong', 'age': 10}, 8 {'name': 'haixiyu', 'age': 11}, 9 ] 10 return HttpResponse(json.dumps(response),stutas=200) 11 12 class UserView(View): 13 def get(self,request,pk): 14 return HttpResponse(json.dumps({'name':'haiyan','age':11})) #返回一條數據 15 def post(self,request,pk): 16 return HttpResponse(json.dumps({'code':1111})) #返回一條數據 17 def put(self,request,pk): 18 pass 19 def delete(self,request,pk): 20 pass
基於django實現的API許多功能都需要我們自己開發，這時候djangorestframework就給我們提供了方便，直接基於它來返回數據，總之原理都是一樣的，就是給一個接口也就是url，讓前端的人去請求這個url去獲取數據，在頁面上顯示出來。這樣也就達到了前后端分離的效果。下面我們來看看基於Django Rest Framework框架實現
五、基於Django Rest Framework框架實現
1、自定義認證規則 ,詳見鏈接
class MyAuthtication(BasicAuthentication): def authenticate(self, request): token = request.query_params.get('token') #注意是沒有GET的，用query_params表示 if token == 'zxxzzxzc': return ('uuuuuu','afsdsgdf') #返回user，auth raise APIException('認證錯誤') class UserView(APIView): authentication_classes = [MyAuthtication,] def get(self,request,*args,**kwargs): print(request.user) print(request.auth) return Response('用戶列表')
2、應用：主要是做Token驗證 url中as_view里面調用了dispatch方法。
可以有兩種方式
局部使用
1 from app01 import views 2 from django.conf.urls import url 3 urlpatterns = [ 4 # django rest framework 5 url('^hosts/', views.HostView.as_view()), 6 url(r'^auth/', views.AuthView.as_view()), 7 ]
1 from django.shortcuts import render,HttpResponse 2 # Create your views here. 3 from rest_framework.views import APIView 4 from rest_framework.views import Request 5 from rest_framework.authentication import SessionAuthentication 6 from rest_framework.authentication import BaseAuthentication, BasicAuthentication 7 from rest_framework.parsers import JSONParser 8 from rest_framework.negotiation import DefaultContentNegotiation 9 from rest_framework.exceptions import APIException 10 from app01 import models 11 from rest_framework.response import Response #友好的顯示返回結果 12 13 14 15 class AuthView(APIView): 16 #auth登錄頁面不需要驗證，可設置 17 authentication_classes = [] #登錄頁面不需要認證 18 def get(self,request): 19 ''' 20 接收用戶名和密碼 21 :param request: 22 :return: 23 ''' 24 ret = {'code':1000,'msg':None} 25 user = request.query_params.get('username') 26 27 pwd = request.query_params.get('password') 28 print(user,pwd) 29 obj = models.UserInfo.objects.filter(username=user,password=pwd).first() 30 print(obj) 31 if not obj : 32 ret['code'] = 1001 33 ret['msg'] = '用戶名或者密碼錯誤' 34 return Response(ret) 35 #創建隨機字符串 36 import time 37 import hashlib 38 ctime = time.time() 39 key = '%s|%s'%(user,ctime) 40 m = hashlib.md5() 41 m.update(key.encode('utf-8')) 42 token = m.hexdigest() 43 44 #保存數據 45 obj.token = token 46 obj.save() 47 48 ret['token'] = token 49 return Response(ret) 50 51 class HostView(APIView): 52 def dispatch(self, request, *args, **kwargs): 53 return super().dispatch(request, *args, **kwargs) 54 55 # authentication_classes = [MyAuthtication] 56 57 def get(self,request,*args,**kwargs): 58 print(request.user,'dddddddddddffffff') 59 print(request.auth,'dddddddddd') 60 #原來的request，django.core.handlers.wsgi.WSGIRequest 61 #現在的request ,rest_framework.request.Request 62 # print(request) 63 authentication_classes = [SessionAuthentication,BaseAuthentication] 64 # print(self.authentication_classes) # [<class 'rest_framework.authentication.SessionAuthentication'>, 65 # <class 'rest_framework.authentication.BasicAuthentication'>] 66 return HttpResponse('GET請求的響應內容') 67 68 def post(self,request,*args,**kwargs): 69 pass 70 # try: 71 # try : 72 # current_page = request.POST.get("page") 73 # 74 # current_page = int(current_page) 75 # int("asd") 76 # except ValueError as e: 77 # print(e) 78 # raise #如果有raise說明自己處理不了了，就交給下面的一個去捕捉了 79 # except Exception as e: 80 # print("OK") 81 82 83 return HttpResponse('post請求的響應內容') 84 85 def put(self, request, *args, **kwargs): 86 return HttpResponse('put請求的響應內容')
全局使用
1 #注冊認證類 2 REST_FRAMEWORK = { 3 'UNAUTHENTICATED_USER': None, 4 'UNAUTHENTICATED_TOKEN': None, #將匿名用戶設置為None 5 "DEFAULT_AUTHENTICATION_CLASSES": [ 6 "app01.utils.MyAuthentication", 7 ], 8 }
1 from rest_framework.authentication import BaseAuthentication 2 from rest_framework.exceptions import APIException 3 from app02 import models 4 5 6 class MyAuthentication(BaseAuthentication): 7 def authenticate(self, request): 8 token=request.query_params.get('token') 9 print(token) 10 obj=models.UserInfo.objects.filter(token=token).first() 11 print(obj) 12 if obj: 13 return (obj.username,obj) 14 raise APIException('沒有通過驗證') 15 16 全局驗證
注：rest_framewor是一個app需要settings里面設置。