Django的restframework接口框架自定義返回數(shù)據(jù)格式的示例詳解
在前后端分離是大趨勢的背景下,前端獲取數(shù)據(jù)都是通過調(diào)用后臺的接口來獲取數(shù)據(jù)微服務(wù)的應(yīng)用越來越多。Django是Python進行web應(yīng)用開發(fā)常用的web框架,用Django框架進行web應(yīng)用框架減少了很多工作,通常用很少量的代碼就可以實現(xiàn)數(shù)據(jù)的增、刪、改、查的業(yè)務(wù)應(yīng)用,同樣用Django的restframework的框架對外發(fā)布接口也是非常的簡單方便,幾行代碼就可以將數(shù)據(jù)對象通過接口的方式提供服務(wù)。因為在實際開發(fā)過程中接口的返回數(shù)據(jù)有一定的格式,本文介紹通過自定義Response返回對象來自定義接口返回數(shù)據(jù)格式。
以下示例將數(shù)據(jù)對象Friend通過restframework框架進行接口發(fā)布。
只要定義Friend數(shù)據(jù)對象
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ù)據(jù)
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/
但是在項目中經(jīng)常會碰到接口格式變化的情況,restframework框架默認的返回數(shù)據(jù)格式不滿足應(yīng)用的需求。比如一般的接口都會有接口返回的code、msg、data,code用來標識接口返回代碼比如200是正常,msg用來記錄異常或其信息,data用來返回具體的數(shù)據(jù)。
通過restframework接口自定義返回數(shù)據(jù)格式也是很簡單方便的。
先自定義Response返回對象,在返回對象中自定義數(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ù)返回時,使用該自定義的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ù)據(jù)格式中增加了code,msg 數(shù)據(jù)放到了data節(jié)點
列表數(shù)據(jù)通常接口要提供翻頁功能,在接口中要有總頁數(shù)、當(dāng)前頁、是否有下一頁的信息。
可以自定義一個分頁器,在分頁器中自定義需要返回的分頁參數(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ù)據(jù)返回時,如果有分頁器則使用該分頁器自定義的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ù)據(jù)要放在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ù)據(jù)放在data節(jié)點里面了
至此,本文介紹了通過Django的restframework接口框架自定義Response返回對象來自定義返回數(shù)據(jù)格式。Django的restframework接口框架使用簡單方便,拿來即用,能夠很大程度上減少代碼開發(fā)量。
到此這篇關(guān)于Django的restframework接口框架自定義返回數(shù)據(jù)格式的文章就介紹到這了,更多相關(guān)Django restframework自定義返回數(shù)據(jù)格式內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
python命令行執(zhí)行腳本找不到模塊ModuleNotFoundError問題
這篇文章主要介紹了python命令行執(zhí)行腳本找不到模塊ModuleNotFoundError問題,具有很好的參考價值,希望對大家有所幫助。如有錯誤或未考慮完全的地方,望不吝賜教2023-06-06Python循環(huán)結(jié)構(gòu)的應(yīng)用場景詳解
這篇文章主要介紹了Python循環(huán)結(jié)構(gòu)的應(yīng)用場景詳解,文中通過示例代碼介紹的非常詳細,對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值,需要的朋友可以參考下2019-07-07Python中json.load()和json.loads()有哪些區(qū)別
json.loads()用于解析一個有效的JSON字符串并將其轉(zhuǎn)換為Python字典,json.load——()用于從一個文件讀取JSON類型的數(shù)據(jù),然后轉(zhuǎn)轉(zhuǎn)換成Python字典,本文講解下python中兩者的使用2021-06-06django框架基于模板 生成 excel(xls) 文件操作示例
這篇文章主要介紹了django框架基于模板 生成 excel(xls) 文件操作,結(jié)合具體實例形式分析了Django框架基于模板生成excel的實現(xiàn)步驟與相關(guān)操作技巧,需要的朋友可以參考下2019-06-06Python Pandas模塊實現(xiàn)數(shù)據(jù)的統(tǒng)計分析的方法
在上一篇講了幾個常用的“Pandas”函數(shù)之后,今天小編就為大家介紹一下在數(shù)據(jù)統(tǒng)計分析當(dāng)中經(jīng)常用到的“Pandas”函數(shù)方法,希望能對大家有所收獲,需要的朋友可以參考下2021-06-06