對Django的restful用法詳解(自帶的增刪改查)
什么是rest
REST是所有Web應(yīng)用都應(yīng)該遵守的架構(gòu)設(shè)計指導(dǎo)原則。
Representational State Transfer,翻譯是”表現(xiàn)層狀態(tài)轉(zhuǎn)化”。
面向資源是REST最明顯的特征,對于同一個資源的一組不同的操作。資源是服務(wù)器上一個可命名的抽象概念,資源是以名詞為核心來組織的,首先關(guān)注的是名詞。
REST要求,必須通過統(tǒng)一的接口來對資源執(zhí)行各種操作。對于每個資源只能執(zhí)行一組有限的操作。
GET用來獲取資源,POST用來新建資源(也可以用于更新資源),PUT(PATCH)用來更新資源,DELETE用來刪除資源。
api定義規(guī)范
http://xxx.com/api/
資源
在RESTful架構(gòu)中,每個網(wǎng)址代表一種資源(resource),所以網(wǎng)址中不能有動詞,只能有名詞,而且所用的名詞往往與數(shù)據(jù)庫的表格名對應(yīng)。一般來說,數(shù)據(jù)庫中的表都是同種記錄的”集合”(collection),所以API中的名詞也應(yīng)該使用復(fù)數(shù)。
舉例來說,有一個API提供動物園(zoo)的信息,還包括各種動物和雇員的信息,則它的路徑應(yīng)該設(shè)計成下面這樣。
https://api.example.com/v1/zoos https://api.example.com/v1/animals https://api.example.com/v1/employees
http請求方式
GET(SELECT):從服務(wù)器取出資源(一項或多項) POST(CREATE):在服務(wù)器新建一個資源 PUT(UPDATE):在服務(wù)器更新資源(客戶端提供改變后的完整資源) PATCH(UPDATE):在服務(wù)器更新資源(客戶端提供改變的屬性) DELETE(DELETE):從服務(wù)器刪除資源
filter過濾
?page=2&per_page=100:指定第幾頁,以及每頁的記錄數(shù)。 ?sortby=name&order=asc:指定返回結(jié)果按照哪個屬性排序,以及排序順序。 ?animal_type_id=1:指定篩選條件
狀態(tài)碼
服務(wù)端向用戶返回請求api的結(jié)果,在結(jié)果中包含了status codes 狀態(tài)碼的,可以通過狀態(tài)碼去判斷請求api的狀態(tài)是成功還是失敗
200 OK - [GET]:服務(wù)器成功返回用戶請求的數(shù)據(jù),該操作是冪等的(Idempotent)。 201 CREATED - [POST/PUT/PATCH]:用戶新建或修改數(shù)據(jù)成功。 202 Accepted - [*]:表示一個請求已經(jīng)進(jìn)入后臺排隊(異步任務(wù)) 204 NO CONTENT - [DELETE]:用戶刪除數(shù)據(jù)成功。 400 INVALID REQUEST - [POST/PUT/PATCH]:用戶發(fā)出的請求有錯誤,服務(wù)器沒有進(jìn)行新建或修改數(shù)據(jù)的操作,該操作是冪等的。 401 Unauthorized - [*]:表示用戶沒有權(quán)限(令牌、用戶名、密碼錯誤)。 403 Forbidden - [*] 表示用戶得到授權(quán)(與401錯誤相對),但是訪問是被禁止的。 404 NOT FOUND - [*]:用戶發(fā)出的請求針對的是不存在的記錄,服務(wù)器沒有進(jìn)行操作,該操作是冪等的。 406 Not Acceptable - [GET]:用戶請求的格式不可得(比如用戶請求JSON格式,但是只有XML格式)。 410 Gone -[GET]:用戶請求的資源被永久刪除,且不會再得到的。 422 Unprocesable entity - [POST/PUT/PATCH] 當(dāng)創(chuàng)建一個對象時,發(fā)生一個驗證錯誤。 500 INTERNAL SERVER ERROR - [*]:服務(wù)器發(fā)生錯誤,用戶將無法判斷發(fā)出的請求是否成功。
具體用法
更多的需要配合postman 因此需要下載一個postman,方便更多的操作
https://www.getpostman.com/apps
使用之前安裝模塊
pip install djangorestframework pip install django-filter
在setting.py中加入?yún)?shù)
INSTALLED_APPS中加入'rest_framework',
在app中創(chuàng)建一個py文件——序列化文件
比如serializers.py然后寫入restful
from rest_framework import serializers from stu.models import Student(導(dǎo)入自己寫的app、models) class StudentSerializer(serializers.ModelSerializer): class Meta: # 關(guān)聯(lián)數(shù)據(jù)表(前面不是變量名) model = Student # 確定需要序列化的字段(返回給用戶的具體表中的字段)(前面不是變量名) fields = ['id', 's_name', 's_tel'] def to_representation(self, instance): data = super().to_representation(instance) try: # 得到關(guān)聯(lián)表中的字段,必須用try,否則如果存在一個沒有定義i_addr的學(xué)生時,系統(tǒng)將報錯 data['s_addr'] = instance.studentinfo.i_addr except Exception as e: data['s_addr'] = '' return data
在app中views中創(chuàng)建類
from rest_framework import mixins,viewsets from stu.serializers import StudentSerializer from stu.models import Student class StudentEdit(mixins.ListModelMixin,# 表示可以在Postman類似的軟件中只能查找所有數(shù)據(jù) viewsets.GenericViewSet, mixins.RetrieveModelMixin, # 表示可以在Postman類似的軟件中只能查找單一數(shù)據(jù) mixins.UpdateModelMixin, # 表示可以在Postman類似的軟件中更新數(shù)據(jù) mixins.DestroyModelMixin, # 表示可以在Postman類似的軟件中刪除數(shù)據(jù) mixins.CreateModelMixin): # 表示可以在Postman類似的軟件中創(chuàng)建數(shù)據(jù) # 查詢所有信息 queryset = Student.objects.all() # 序列化 serializer_class = StudentSerializer
創(chuàng)建urls
這里同時展示了urls不一定每次都寫入進(jìn)去可以用+=添加進(jìn)去
注意這里寫的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
對應(yīng)的方法
在postman中選入某個參數(shù)然后傳入某個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
能執(zhí)行這些操作前都需要在views中定義好才行
以上這篇對Django的restful用法詳解(自帶的增刪改查)就是小編分享給大家的全部內(nèi)容了,希望能給大家一個參考,也希望大家多多支持腳本之家。
- Django JWT Token RestfulAPI用戶認(rèn)證詳解
- Python利用Django如何寫restful api接口詳解
- 詳解Django rest_framework實現(xiàn)RESTful API
- Django用戶認(rèn)證系統(tǒng)如何實現(xiàn)自定義
- Django自帶用戶認(rèn)證系統(tǒng)使用方法解析
- Django多數(shù)據(jù)庫聯(lián)用實現(xiàn)方法解析
- Django數(shù)據(jù)庫遷移常見使用方法
- Django基于Models定制Admin后臺實現(xiàn)過程解析
- Django restful framework生成API文檔過程詳解
相關(guān)文章
Pandas使用分隔符或正則表達(dá)式將字符串拆分為多列
本文主要介紹了Pandas使用分隔符或正則表達(dá)式將字符串拆分為多列,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-02-02Python使用Chrome插件實現(xiàn)爬蟲過程圖解
這篇文章主要介紹了Python使用Chrome插件實現(xiàn)爬蟲,文中通過示例代碼介紹的非常詳細(xì),對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2020-06-06解決python3 安裝完P(guān)ycurl在import pycurl時報錯的問題
今天小編就為大家分享一篇解決python3 安裝完P(guān)ycurl在import pycurl時報錯的問題,具有很好的參考價值,希望對大家有所幫助。一起跟隨小編過來看看吧2018-10-10