對Django的restful用法詳解(自帶的增刪改查)
什麼是rest
REST是所有Web應用都應該遵守的架構設計指導原則。
Representational State Transfer,翻譯是”表現層狀態轉化”。
面向資源是REST最明顯的特徵,對於同一個資源的一組不同的操作。資源是伺服器上一個可命名的抽象概念,資源是以名詞為核心來組織的,首先關注的是名詞。
REST要求,必須通過統一的介面來對資源執行各種操作。對於每個資源只能執行一組有限的操作。
GET用來獲取資源,POST用來新建資源(也可以用於更新資源),PUT(PATCH)用來更新資源,DELETE用來刪除資源。
api定義規範
http://xxx.com/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
http請求方式
GET(SELECT):從伺服器取出資源(一項或多項) POST(CREATE):在伺服器新建一個資源 PUT(UPDATE):在伺服器更新資源(客戶端提供改變後的完整資源) PATCH(UPDATE):在伺服器更新資源(客戶端提供改變的屬性) DELETE(DELETE):從伺服器刪除資源
filter過濾
?page=2&per_page=100:指定第幾頁,以及每頁的記錄數。 ?sortby=name&order=asc:指定返回結果按照哪個屬性排序,以及排序順序。 ?animal_type_id=1:指定篩選條件
狀態碼
服務端向用戶返回請求api的結果,在結果中包含了status codes 狀態碼的,可以通過狀態碼去判斷請求api的狀態是成功還是失敗
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 - [*]:伺服器發生錯誤,使用者將無法判斷髮出的請求是否成功。
具體用法
更多的需要配合postman 因此需要下載一個postman,方便更多的操作
https://www.getpostman.com/apps
使用之前安裝模組
pip install djangorestframework pip install django-filter
在setting.py中加入引數
INSTALLED_APPS中加入'rest_framework',
在app中建立一個py檔案——序列化檔案
比如serializers.py然後寫入restful
from rest_framework import serializers from stu.models import Student(匯入自己寫的app、models) class StudentSerializer(serializers.ModelSerializer): class Meta: # 關聯資料表(前面不是變數名) model = Student # 確定需要序列化的欄位(返回給使用者的具體表中的欄位)(前面不是變數名) fields = ['id','s_name','s_tel'] def to_representation(self,instance): data = super().to_representation(instance) try: # 得到關聯表中的欄位,必須用try,否則如果存在一個沒有定義i_addr的學生時,系統將報錯 data['s_addr'] = instance.studentinfo.i_addr except Exception as e: data['s_addr'] = '' return data
在app中views中建立類
from rest_framework import mixins,viewsets from stu.serializers import StudentSerializer from stu.models import Student class StudentEdit(mixins.ListModelMixin,# 表示可以在Postman類似的軟體中只能查詢所有資料 viewsets.GenericViewSet,mixins.RetrieveModelMixin,# 表示可以在Postman類似的軟體中只能查詢單一資料 mixins.UpdateModelMixin,# 表示可以在Postman類似的軟體中更新資料 mixins.DestroyModelMixin,# 表示可以在Postman類似的軟體中刪除資料 mixins.CreateModelMixin): # 表示可以在Postman類似的軟體中建立資料 # 查詢所有資訊 queryset = Student.objects.all() # 序列化 serializer_class = StudentSerializer
建立urls
這裡同時展示了urls不一定每次都寫入進去可以用+=新增進去
注意這裡寫的urls不要加‘/'他會自動載入
from stu import views from rest_framework.routers import SimpleRouter router = SimpleRouter() router.register(r'student',views.StudentEdit) urlpatterns = [ # 其他url ] urlpatterns += router.urls #這裡表示新增定義的url
對應的方法
在postman中選入某個引數然後傳入某個urls即可
增: POST http://127.0.0.1:8080/stu/addStu/1/ 刪: DELETE http://127.0.0.1:8080/stu/addStu/1/ 改: UPDATE http://127.0.0.1:8080/stu/addStu/1/ 查: GET http://127.0.0.1:8080/stu/addStu/1
能執行這些操作前都需要在views中定義好才行
以上這篇對Django的restful用法詳解(自帶的增刪改查)就是小編分享給大家的全部內容了,希望能給大家一個參考,也希望大家多多支援我們。