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