RESTful API

来源:https://www.cnblogs.com/huchong/archive/2018/02/14/8448639.html
-Advertisement-
Play Games

一、 什麼是RESTful REST與技術無關，代表的是一種軟體架構風格，REST是Representational State Transfer的簡稱，中文翻譯為“表徵狀態轉移” REST從資源的角度類審視整個網路，它將分佈在網路中某個節點的資源通過URL進行標識，客戶端應用通過URL來獲取資源的 ...


一、 什麼是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模式：

from django.contrib import admin

from django.conf.urls import url, include
from app01 import views
from app02 import views

urlpatterns = [
    url('admin/', admin.site.urls),
    # path('hosts/',views.HostView.as_view()),
    url('app02/', include('app02.urls'))
]
全局url 
from app02 import views
from django.conf.urls import url
urlpatterns = [
    url('^users/', views.users),
    url('^user/(\d+)', views.user),


]
app02/url 
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
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/urls 
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
views

基於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 views
from django.conf.urls import url
urlpatterns = [
    # django rest framework
    url('^hosts/', views.HostView.as_view()),
    url(r'^auth/', views.AuthView.as_view()),
]
urls.py 
from django.shortcuts import render,HttpResponse
# Create your views here.
from rest_framework.views import  APIView
from rest_framework.views import Request
from rest_framework.authentication import SessionAuthentication
from rest_framework.authentication import BaseAuthentication, BasicAuthentication
from rest_framework.parsers import JSONParser
from rest_framework.negotiation import  DefaultContentNegotiation
from rest_framework.exceptions import APIException
from app01 import models
from 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",
    ],
}
settings 
from  rest_framework.authentication import BaseAuthentication
from rest_framework.exceptions import APIException
from app02 import models


class 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裡面設置。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • hibernate框架學習筆記5：緩存
    緩存不止存在與程式中，電腦硬體乃至於生活中都存在緩存 目的：提高效率 比如IO流讀寫位元組，如果沒有緩存，讀一位元組寫一位元組，效率低下 hibernate中的一級緩存：提高操作資料庫的效率 示例： 抽取的工具類 package utils; import org.hibernate.Session; i ...
  • hibernate框架學習筆記4：主鍵生成策略、對象狀態
    創建一個實體類： package domain; public class Customer { private Long cust_id; private String cust_name; private String cust_source; private String cust_indus ...
  • 面試題：私有構造方法類外部能訪問嗎，用什麼方法？反射
    反射的時候通過暴力破解是可以訪問的 用反射的方法調用上面的類 對構造器進行暴力破解後，私有的構造也可以訪問，這個構造器的獲得要通過getDeclaredConstructor()方法 ...
  • Maven_02、maven的入門項目的演示
    前言 所有編程都喜歡從hello world開始，所以今天我們也從hello world來介紹一下maven的入門程式。 一、maven入門程式的搭建過程以及步驟 1.1maven的目錄結構 1.1.1入門項目的目錄構建 maven的目錄結構大致如下： 首先我們在項目中建立如下結構： 【註意】其中p ...
  • 函數（一）
    定義函數： 過程：就是沒有返回值的函數 函數的參數： 形參：只有在被調用時才分配記憶體單元，在調用結束時，即刻釋放所分配的記憶體單元。因此，形參只在函數內部有效。 實參：可以是常量、變數、表達式、函數等，在進行函數調用時，都必須有確定的值，以便把這些值傳給形參。 全局變數和局部變數： 在子程式中定義的變 ...
  • this關鍵字
    this關鍵字只能在方法內部使用，表示對“調用方法的那個對象”的引用。 構造器內可以用this調用一個構造器，並且必須將構造器調用置於最起始處。除構造器外，編譯器禁止在其他任何方法中調用構造器。 ...
  • Python爬蟲學習==>第一章：Python3+Pip環境配置
    前置操作 軟體名：anaconda 版本：Anaconda3-5.0.1-Windows-x86_64清華鏡像 下載鏈接：https://mirrors.tuna.tsinghua.edu.cn/anaconda/archive/ 軟體名：Pycharm 版本：pycharm-professiona ...
  • 劍指offer試題（PHP篇一）
    1.二維數組中的查找 題目描述 在一個二維數組中，每一行都按照從左到右遞增的順序排序，每一列都按照從上到下遞增的順序排序。請完成一個函數，輸入這樣的一個二維數組和一個整數，判斷數組中是否含有該整數。 時間限制：1秒 空間限制：32768K <?php function Find($target, $ ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類