Django的restframework接口框架自定義返回?cái)?shù)據(jù)格式的示例詳解
在前后端分離是大趨勢(shì)的背景下，前端獲取數(shù)據(jù)都是通過(guò)調(diào)用后臺(tái)的接口來(lái)獲取數(shù)據(jù)微服務(wù)的應(yīng)用越來(lái)越多。Django是Python進(jìn)行web應(yīng)用開(kāi)發(fā)常用的web框架，用Django框架進(jìn)行web應(yīng)用框架減少了很多工作，通常用很少量的代碼就可以實(shí)現(xiàn)數(shù)據(jù)的增、刪、改、查的業(yè)務(wù)應(yīng)用，同樣用Django的restframework的框架對(duì)外發(fā)布接口也是非常的簡(jiǎn)單方便，幾行代碼就可以將數(shù)據(jù)對(duì)象通過(guò)接口的方式提供服務(wù)。因?yàn)樵趯?shí)際開(kāi)發(fā)過(guò)程中接口的返回?cái)?shù)據(jù)有一定的格式，本文介紹通過(guò)自定義Response返回對(duì)象來(lái)自定義接口返回?cái)?shù)據(jù)格式。
以下示例將數(shù)據(jù)對(duì)象Friend通過(guò)restframework框架進(jìn)行接口發(fā)布。
只要定義Friend數(shù)據(jù)對(duì)象
class Friend(BaseModel):
id=models.AutoField(primary_key=True)
siteName=models.CharField(max_length=20, verbose_name='友鏈站點(diǎn)名稱')
path=models.CharField(max_length=100, verbose_name='地址路徑')
desc=models.CharField(max_length=200, verbose_name='描述')
def __str__(self):
return self.siteName
class Meta:
verbose_name='友鏈'
verbose_name_plural='友鏈'
定義一個(gè)序列化類將返回的字段序列化
class FriendModelSerializer(serializers.ModelSerializer):
class Meta:
model = Friend
fields = "__all__"
定義一個(gè)接口視圖類獲取數(shù)據(jù)
class FriendView(viewsets.ModelViewSet):
queryset = Friend.objects.all()
serializer_class = FriendModelSerializer
定義接口路由就可以通過(guò)httprestfull的接口進(jìn)行訪問(wèn)了
friend_list=views.FriendView.as_view({'get':'list',})
urlpatterns = [
path('friend/',friend_list),
]接口訪問(wèn)效果如下：
http://localhost:8000/api/friend/
但是在項(xiàng)目中經(jīng)常會(huì)碰到接口格式變化的情況，restframework框架默認(rèn)的返回?cái)?shù)據(jù)格式不滿足應(yīng)用的需求。比如一般的接口都會(huì)有接口返回的code、msg、data，code用來(lái)標(biāo)識(shí)接口返回代碼比如200是正常，msg用來(lái)記錄異?；蚱湫畔?，data用來(lái)返回具體的數(shù)據(jù)。
通過(guò)restframework接口自定義返回?cái)?shù)據(jù)格式也是很簡(jiǎn)單方便的。
先自定義Response返回對(duì)象，在返回對(duì)象中自定義數(shù)據(jù)返回的格式，示例代碼如下：
from rest_framework.response import Response
from rest_framework.serializers import Serializer
class CustomResponse(Response):
def __init__(self,data=None,code=None,msg=None,
status=None,
template_name=None, headers=None,
exception=False, content_type=None,**kwargs):
super().__init__(None, status=status)
if isinstance(data, Serializer):
msg = (
'You passed a Serializer instance as data, but '
'probably meant to pass serialized `.data` or '
'`.error`. representation.'
)
raise AssertionError(msg)
#自定義返回格式
self.data={'code':code,'msg':msg,'data':data}
self.data.update(kwargs)
self.template_name=template_name
self.exception=exception
self.content_type=content_type
if headers:
for name, value in headers.items():
self[name] = value
在接口接口視圖類獲取數(shù)據(jù)返回時(shí)，使用該自定義的Response返回對(duì)象。
class FriendView(viewsets.ModelViewSet):
queryset = Friend.objects.all()
serializer_class = FriendModelSerializer
#自定義list方法，自定義Response返回
def list(self, request, *args, **kwargs):
queryset = self.filter_queryset(self.get_queryset())
serializer = self.get_serializer(queryset, many=True)
return CustomResponse(data=serializer.data, code=200, msg="OK", status=status.HTTP_200_OK)
接口訪問(wèn)效果如下：
可以看到返回?cái)?shù)據(jù)格式中增加了code,msg 數(shù)據(jù)放到了data節(jié)點(diǎn)
列表數(shù)據(jù)通常接口要提供翻頁(yè)功能，在接口中要有總頁(yè)數(shù)、當(dāng)前頁(yè)、是否有下一頁(yè)的信息。
可以自定義一個(gè)分頁(yè)器，在分頁(yè)器中自定義需要返回的分頁(yè)參數(shù)
參考示例代碼如下：
from rest_framework import status
from rest_framework.pagination import PageNumberPagination
from common.customresponse import CustomResponse
class MyPage(PageNumberPagination):
page_size = 8 #每頁(yè)顯示數(shù)量
max_page_size = 50 #每頁(yè)最大顯示數(shù)量。
page_size_query_param = 'size' #每頁(yè)數(shù)量的參數(shù)名稱
page_query_param = 'page' #頁(yè)碼的參數(shù)名稱
def get_paginated_response(self, data):
#自定義分頁(yè)器的返回參數(shù)
return CustomResponse(data=data,code=200,msg="OK",status=status.HTTP_200_OK, count=self.page.paginator.count,next=self.get_next_link(),previous=self.get_previous_link(),size=self.page_size,page=self.page.number)
在接口接口視圖類獲取數(shù)據(jù)返回時(shí)，如果有分頁(yè)器則使用該分頁(yè)器自定義的Response返回對(duì)象。
class FriendView(viewsets.ModelViewSet):
queryset = Friend.objects.all()
serializer_class = FriendModelSerializer
pagination_class = MyPage
#自定義list方法，自定義Response返回
def list(self, request, *args, **kwargs):
queryset = self.filter_queryset(self.get_queryset())
page = self.paginate_queryset(queryset)
#如果有分頁(yè)器，則進(jìn)行分頁(yè)后返回
if page is not None:
serializer = self.get_serializer(page, many=True)
return self.get_paginated_response(serializer.data)
serializer = self.get_serializer(queryset, many=True)
return CustomResponse(data=serializer.data, code=200, msg="OK", status=status.HTTP_200_OK)
接口訪問(wèn)效果如下：
可以看到接口中自定義增加了分頁(yè)信息。
但是有時(shí)候可能希望分頁(yè)的信息數(shù)據(jù)要放在data節(jié)點(diǎn)里面，這樣也是可以做到的。
from rest_framework import status
from rest_framework.pagination import PageNumberPagination
from common.customresponse import CustomResponse
class MyPage(PageNumberPagination):
page_size = 8 #每頁(yè)顯示數(shù)量
max_page_size = 50 #每頁(yè)最大顯示數(shù)量。
page_size_query_param = 'size' #每頁(yè)數(shù)量的參數(shù)名稱
page_query_param = 'page' #頁(yè)碼的參數(shù)名稱
#自定義分頁(yè)器的返回參數(shù)
def get_paginated_response(self, data):
ret_data = dict()
ret_data['items'] = data
# 加入自定義分頁(yè)信息
ret_data['total'] = self.page.paginator.count
ret_data['hasNextPage'] = self.get_next_link()
ret_data['size'] = self.page_size
ret_data['page'] = self.page.number
return CustomResponse(data=ret_data,code=200,msg="OK",status=status.HTTP_200_OK)
接口訪問(wèn)效果如下：
可以看到接口中自定義增加了分頁(yè)信息，分頁(yè)的信息數(shù)據(jù)放在data節(jié)點(diǎn)里面了
至此，本文介紹了通過(guò)Django的restframework接口框架自定義Response返回對(duì)象來(lái)自定義返回?cái)?shù)據(jù)格式。Django的restframework接口框架使用簡(jiǎn)單方便，拿來(lái)即用，能夠很大程度上減少代碼開(kāi)發(fā)量。
到此這篇關(guān)于Django的restframework接口框架自定義返回?cái)?shù)據(jù)格式的文章就介紹到這了,更多相關(guān)Django restframework自定義返回?cái)?shù)據(jù)格式內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
作為一個(gè)功能強(qiáng)大的工具軟件,Matlab具有很強(qiáng)的圖形處理功能,提供了大量的二維、三 維圖形函數(shù),這篇文章主要給大家介紹了關(guān)于如何利用Matlab繪制各類特殊圖形的相關(guān)資料,需要的朋友可以參考下2021-07-07
Numpy中轉(zhuǎn)置transpose、T和swapaxes的實(shí)例講解
下面小編就為大家分享一篇Numpy中轉(zhuǎn)置transpose、T和swapaxes的實(shí)例講解，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2018-04-04
用Python刪除本地目錄下某一時(shí)間點(diǎn)之前創(chuàng)建的所有文件的實(shí)例
下面小編就為大家分享一篇用Python刪除本地目錄下某一時(shí)間點(diǎn)之前創(chuàng)建的所有文件的實(shí)例，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2017-12-12
基于Python編寫簡(jiǎn)單實(shí)用的日志裝飾器
在寫代碼的時(shí)候，往往會(huì)漏掉日志這個(gè)關(guān)鍵因素，導(dǎo)致功能在使用的時(shí)候出錯(cuò)卻無(wú)法溯源。這個(gè)時(shí)候只要利用日志裝飾器就能解決，本文將用Python自制一個(gè)簡(jiǎn)單實(shí)用的日志裝飾器，需要的可以參考一下2022-05-05
Python批量將圖片灰度化的實(shí)現(xiàn)代碼
這篇文章主要介紹了Python批量將圖片灰度化的實(shí)現(xiàn)代碼，本文給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2020-04-04
對(duì)python append 與淺拷貝的實(shí)例講解
今天小編就為大家分享一篇對(duì)python append 與淺拷貝的實(shí)例講解，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。一起跟隨小編過(guò)來(lái)看看吧2018-05-05
這篇文章主要介紹了Python字符串的轉(zhuǎn)義字符，轉(zhuǎn)義字符是指，用一些普通字符的組合來(lái)代替一些特殊字符，由于其組合改變了原來(lái)字符表示的含義，下文相關(guān)資料需要的小伙伴可以參考一下2022-04-04
Python基于smtplib模塊發(fā)送郵件代碼實(shí)例
這篇文章主要介紹了Python基于smtplib模塊發(fā)送郵件代碼實(shí)例,文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-05-05
pydoc?是一個(gè)強(qiáng)大且易于使用的工具,用于生成Python代碼的文檔,通過(guò)解析代碼中的文檔字符串,?pydoc?能夠自動(dòng)生成清晰、易讀的文檔,并提供一個(gè)用戶友好的界面來(lái)查看和瀏覽文檔,本文提供了一個(gè)簡(jiǎn)單的示例2024-01-01
基于Python實(shí)現(xiàn)的微信好友數(shù)據(jù)分析
這篇文章主要介紹了基于Python實(shí)現(xiàn)的微信好友數(shù)據(jù)分析的相關(guān)知識(shí)，非常不錯(cuò)，具有參考借鑒價(jià)值,需要的朋友可以參考下2018-02-02