RESTful API，restfulapi

RESTful API，restfulapi
一、 什麼是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/zooshttps://api.example.com/v1/animalshttps://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模式：from django.contrib import adminfrom django.conf.urls import url, includefrom app01 import viewsfrom app02 import viewsurlpatterns = [ url('admin/', admin.site.urls), # path('hosts/',views.HostView.as_view()), url('app02/', include('app02.urls'))]全域urlfrom app02 import viewsfrom django.conf.urls import urlurlpatterns = [ url('^users/', views.users), url('^user/(\d+)', views.user),]app02/urlfrom django.shortcuts import render,HttpResponse# Create your views here.import jsondef 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 views

 

方式二：CBV模式 from app02 import views from django.conf.urls import url urlpatterns = [ url('^users/', views.UsersView.as_view()), url('^user/', views.UserView.as_view()), ]app02/urlsfrom django.views import Viewclass 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): passviews

基於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方法。

可以有兩種方式

局部使用from app01 import viewsfrom django.conf.urls import urlurlpatterns = [ # django rest framework url('^hosts/', views.HostView.as_view()), url(r'^auth/', views.AuthView.as_view()),]urls.pyfrom django.shortcuts import render,HttpResponse# Create your views here.from rest_framework.views import APIViewfrom rest_framework.views import Requestfrom rest_framework.authentication import SessionAuthenticationfrom rest_framework.authentication import BaseAuthentication, BasicAuthenticationfrom rest_framework.parsers import JSONParserfrom rest_framework.negotiation import DefaultContentNegotiationfrom rest_framework.exceptions import APIExceptionfrom app01 import modelsfrom rest_framework.response import Response #友好的顯示返回結果class AuthView(APIView): #auth登入頁面不需要驗證，可設定 authentication_classes = [] #登入頁面不需要認證 def get(self,request): ''' 接收使用者名稱和密碼 :param request: :return: ''' ret = {'code':1000,'msg':None} user = request.query_params.get('username') pwd = request.query_params.get('password') print(user,pwd) obj = models.UserInfo.objects.filter(username=user,password=pwd).first() print(obj) if not obj : ret['code'] = 1001 ret['msg'] = '使用者名稱或者密碼錯誤' return Response(ret) #建立隨機字串 import time import hashlib ctime = time.time() key = '%s|%s'%(user,ctime) m = hashlib.md5() m.update(key.encode('utf-8')) token = m.hexdigest() #儲存資料 obj.token = token obj.save() ret['token'] = token return Response(ret)class HostView(APIView): def dispatch(self, request, *args, **kwargs): return super().dispatch(request, *args, **kwargs) # authentication_classes = [MyAuthtication] def get(self,request,*args,**kwargs): print(request.user,'dddddddddddffffff') print(request.auth,'dddddddddd') #原來的request，django.core.handlers.wsgi.WSGIRequest #現在的request ,rest_framework.request.Request # print(request) authentication_classes = [SessionAuthentication,BaseAuthentication] # print(self.authentication_classes) # [<class 'rest_framework.authentication.SessionAuthentication'>, # <class 'rest_framework.authentication.BasicAuthentication'>] return HttpResponse('GET請求的響應內容') def post(self,request,*args,**kwargs): pass # try: # try : # current_page = request.POST.get("page") # # current_page = int(current_page) # int("asd") # except ValueError as e: # print(e) # raise #如果有raise說明自己處理不了了，就交給下面的一個去捕捉了 # except Exception as e: # print("OK") return HttpResponse('post請求的響應內容') def put(self, request, *args, **kwargs): return HttpResponse('put請求的響應內容')Views.py全域使用#註冊認證類REST_FRAMEWORK = { 'UNAUTHENTICATED_USER': None, 'UNAUTHENTICATED_TOKEN': None, #將匿名使用者設定為None "DEFAULT_AUTHENTICATION_CLASSES": [ "app01.utils.MyAuthentication", ],}settingsfrom rest_framework.authentication import BaseAuthenticationfrom rest_framework.exceptions import APIExceptionfrom app02 import modelsclass MyAuthentication(BaseAuthentication): def authenticate(self, request): token=request.query_params.get('token') print(token) obj=models.UserInfo.objects.filter(token=token).first() print(obj) if obj: return (obj.username,obj) raise APIException('沒有通過驗證')全域驗證

註：rest_framewor是一個app需要settings裡面設定。