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