1. 程式人生 > 實用技巧 >入門規範

入門規範

目錄

入門規範

本週內容

#django-rest-framework(drf)入門規範
#drf序列化元件
#drf請求響應與響應
#drf檢視元件
#drf路由元件
#drf三大認證:認證、許可權、頻率
#drf過濾排序分頁異常處理
#drf自動生成介面文件
#drf-django-rest-framework-jwt(JWT)認證
#drf-xadmin的使用
#BOOK系列多表群操作
#RBAC基於角色的訪問控制

1 web開發模式

#前後端混合開發:後端返回的是html內容,需要寫模板
#前後端分離開發:專注於寫後端介面,返回json、xml格式資料
#json格式
	{"name":"joab","age":18}
#xml格式
    <xml>
    <name>joab</name>
    <age>18</age>
    </xml>
#jave的jsp格式
#php寫的
#python寫的

#什麼是動態頁面(查資料的),什麼是靜態頁面(靜止的html)
#頁面靜態化

api介面

#通過網路,規定了前後端資訊互動規則的url連結,也就是前後臺資訊互動的媒介
#列如:http://127.0.0.1:8000/app01/car/	獲取app01應用下的所有車型介面

postman的使用

#postman是目前最好用的,模擬傳送http請求的工具
#雙擊安裝、安裝完成開啟不需要註冊
#解析json的網站
	http://www.json.cn/
#請求頭中User-Agent:是客戶端的型別,還有其他的引數自己檢視一下
#批量介面匯出和測試,實操一下

Restful規範(重點)

#REST全稱是Representational State Transfer,中文意思是表述(通常編譯為表徵狀態轉移),它首次出現在200年的菲爾丁(Roy Fielding)博士的論文中
#RESTFUL是一種定義Web API介面設計規範,尤其與用於前後端的應用模式中

#這種風格的理念認為後端開發任務就是提供資料的,對提供的是資料資源的介面,所以在定義介面時,客戶端訪問的URL路徑就表示這種要操作的資料資源

#事實上,我們可以使用任何一個框架都可以實現restful規範的API介面

#抓包工具:fiddler,charles

#10條restful規範
1 資料的安全保障:url連結一般都採用https協議,可以提高資料互動過程中的安全性
2 介面的特徵表現,一看就知道是個api介面
	https://api.baidu.com
	https://baidu.com/api
	看到api字眼,就代表該請求url是完成前後臺數據互動
	#路飛的介面:https://api.luffycity.com/api/v1/course/free/
3 多資料版本共存
	在url連結中標示資料版本
	https://api.baidu.com/v1
	https://api.baidu.com/v2
	url連結中的v1、v2就是不同資料版本的體現(只有在一種資料資源有多版本的情況下)
4 資料即資源,均使用名詞(可複數)
	介面一般都是完成前後臺數據的互動,互動的資料我們稱之為資源
	http://127.0.0.1/users
	http://127.0.0.1/books
	http://127.0.0.1/cars
	#一般提倡用資源的複數形式,不要出現動詞
	#特殊的的介面可以出現動詞,因為這些介面沒有一個明確的資源,或是動詞(login)就是介面的核心含義
5 資源操作由請求方式決定,操作資源一般都會涉及增刪查改,我們提供請求方式來標示增刪查改動作
	  - https://api.baidu.com/books -  get:獲取所有書
      - https://api.baidu.com/books/1 - get:獲取主鍵為1的書
      - https://api.baidu.com/books - post:新增一本書
      - https://api.baidu.com/books/1 - put:整體修改主鍵為1的書
      - https://api.baidu.com/books/1 - patch:區域性修改為1的書(基本不用,主要用put即可)
      - https://api.baidu.com/books/1 - delete:刪除主鍵為1的書
6 過濾,通過在url上傳的形式傳遞搜尋條件
	https://api.baidu.com/v1/zoos?limit=10	指定返回的數量
	https://api.baidu.com/v1/zoos?offset=10	指定返回的開始位置
	https://api.baidu.com/v1/zoos?page=2&order=asc	指定返回結果按照那個屬性排序以及排序順序
	https://api.baidu.com/v1/zoos?animal_type_id=1	指定篩選條件
7 響應狀態碼
	1 200x正常響應
		200 請求成功
		201 建立成功
	2 3xx重定向響應
		301 永久重定向
		302 臨時重定向
	3 4xx客戶端異常
		403 請求無許可權
		404 請求路徑不存在
		405 請求方式不存在
	4 5xx服務端異常
		500 服務端異常
8 錯誤處理,應返回錯誤資訊,error當做key
	{error:"錯誤資訊"}
9 返回結果,針對不同操作,伺服器向用戶返回的結果應該符合以下規範
	GET/collection	返回資源物件的列表(陣列)
	GET/collection/resourse	返回單個資源物件
	POST/collection/	返回新生成的資源物件
	PUT/collection/resourse	返回完整的資源物件
	PATCH/collection/resourse	返回完整的資源物件
	DELETE/collection/resourse	返回一個空文件
10 需要url請求的資源需要訪問資源的請求連結
    {"states": 100,
     "msg": "OK",
     "data": [
    	{"name": "egon",
    	"age": 18}
    ]}

drf的安裝和簡單使用

#安裝
	pip3 install djangorestframework==3.10.3
#使用
	1 在setting.py 的app中註冊
		INSTALLED_APPS = [
		'rest_framework',
		]
	2 在models.py中寫表模型
	class Book(models.Model):
        id = models.AutoField(primary_key=True)#可以不寫id主鍵欄位,會自動生成
        name = models.CharField(max_length=32)#CharField欄位必須加max_length引數
        price = models.DecimalField(decimal_places=2,max_digits=6)#decimal_places保留小數2位,max_digits做大位數6位
        author = models.CharField(max_length=32)
	3 新建一個序列化類
		from rest_framework import serializers

        from app01.models import Book


        class BookModelSerializer(serializers.ModelSerializer):

            class Meta:#巢狀類,給上級類新增屬性或功能
                model = Book
                fields = "__all__"
	4 在檢視中寫檢視類
    from rest_framework.viewsets import ModelViewSet
    from .models import Book
    from .ser import BookModelSerializer


    class BooksViewSet(ModelViewSet):#繼承ModelViewSet可以自動生成路由
        queryset = Book.objects.all()
        serializer_class = BookModelSerializer
    5 寫路由關係
    	from app01 import views
        #匯入路由
        from rest_framework.routers import DefaultRouter
        #例項化路由物件
        router = DefaultRouter()
        #註冊
        router.register('book',views.ModelViewSet)
        urlpatterns = [
            path('admin/', admin.site.urls),
        ]
        #加入到路由中
        urlpatterns += router.urls
     #之後就有5個介面可以使用了,postman測試即可

補充

#一切皆物件
    def func(a,b):
        return a+b


    func.name = "joab" #由於一切皆物件,函式也是物件,可以給他賦值

    print(func.name)#joab
#區域性進入csrf,兩種方式
	1 檢視函式上寫@csrf_exempt,需要匯入from django.views.decorators.csrf import csrf_exempt
	2 路由裡寫path('login/', csrf_exempt(views.login)),跟上面是一樣的,需要匯入from django.views.decorators.csrf import csrf_exempt