Django的restframework接口处的框架进行自定义返回数据格式代码详解

　　小编写这篇文章的主要目的，就是给大家进行介绍在python中，使用Django的restframework接口处的框架进行自定义返回数据，并给大家贴出了具体代码，大家可以进行仔细的阅读。

　　就目前来看，前后端分离是一个比较大的趋势，前端获取数据的方式，主要是通过调用接口的形式，来获取到后端的应用服务。Django是Python进行web应用开发常用的web框架，用Django框架进行web应用框架减少了很多工作，使用较少的代码，就能完成很大的一个工作量。

　　同样用Django的restframework的相关框架，向外部，几行代码就可以将数据对象通过接口的方式提供服务。因为在实际开发过程中接口的返回数据有一定的格式，本文介绍通过自定义Response返回对象来自定义接口返回数据格式。

　　以下示例将数据对象Friend通过restframework框架进行接口发布。

　　只要定义Friend数据对象

　　classFriend(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):
　　returnself.siteName
　　classMeta:
　　verbose_name='友链'
　　verbose_name_plural='友链'

　　定义一个序列化类将返回的字段序列化

　classFriendModelSerializer(serializers.ModelSerializer):
　　classMeta:
　　model=Friend
　　fields="__all__"

　　定义一个接口视图类获取数据

　classFriendView(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框架默认的返回数据格式不满足应用的需求。比如一般的接口都会有接口返回的code、msg、data，code用来标识接口返回代码比如200是正常，msg用来记录异常或其信息，data用来返回具体的数据。

　　通过restframework接口自定义返回数据格式也是很简单方便的。

　　先自定义Response返回对象，在返回对象中自定义数据返回的格式，示例代码如下：

　　fromrest_framework.responseimportResponse
　　fromrest_framework.serializersimportSerializer
　　classCustomResponse(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)
　　ifisinstance(data,Serializer):
　　msg=(
　　'YoupassedaSerializerinstanceasdata,but'
　　'probablymeanttopassserialized`.data`or'
　　'`.error`.representation.'
　　)
　　raiseAssertionError(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
　　ifheaders:
　　forname,valueinheaders.items():
　　self[name]=value
　　在接口接口视图类获取数据返回时，使用该自定义的Response返回对象。
　　classFriendView(viewsets.ModelViewSet):
　　queryset=Friend.objects.all()
　　serializer_class=FriendModelSerializer
　　#自定义list方法，自定义Response返回
　　deflist(self,request,*args,**kwargs):
　　queryset=self.filter_queryset(self.get_queryset())
　　serializer=self.get_serializer(queryset,many=True)
　　returnCustomResponse(data=serializer.data,code=200,msg="OK",status=status.HTTP_200_OK)

　　接口访问效果如下：

　　可以看到返回数据格式中增加了code,msg数据放到了data节点

　　列表数据通常接口要提供翻页功能，在接口中要有总页数、当前页、是否有下一页的信息。

　　可以自定义一个分页器，在分页器中自定义需要返回的分页参数

　　参考示例代码如下：

　　fromrest_frameworkimportstatus
　　fromrest_framework.paginationimportPageNumberPagination
　　fromcommon.customresponseimportCustomResponse
　　classMyPage(PageNumberPagination):
　　page_size=8#每页显示数量
　　max_page_size=50#每页最大显示数量。
　　page_size_query_param='size'#每页数量的参数名称
　　page_query_param='page'#页码的参数名称
　　defget_paginated_response(self,data):
　　#自定义分页器的返回参数
　　returnCustomResponse(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)

　　在接口接口视图类获取数据返回时，如果有分页器则使用该分页器自定义的Response返回对象。

　　classFriendView(viewsets.ModelViewSet):

　　queryset=Friend.objects.all()

　　serializer_class=FriendModelSerializer

　　pagination_class=MyPage

　　#自定义list方法，自定义Response返回

　　deflist(self,request,*args,**kwargs):

　　queryset=self.filter_queryset(self.get_queryset())

　　page=self.paginate_queryset(queryset)

　　#如果有分页器，则进行分页后返回

　　ifpageisnotNone:

　　serializer=self.get_serializer(page,many=True)

　　returnself.get_paginated_response(serializer.data)

　　serializer=self.get_serializer(queryset,many=True)

　　returnCustomResponse(data=serializer.data,code=200,msg="OK",status=status.HTTP_200_OK)

　　接口访问效果如下：

　　可以看到接口中自定义增加了分页信息。

　　但是有时候可能希望分页的信息数据要放在data节点里面，这样也是可以做到的。

　fromrest_frameworkimportstatus
　　fromrest_framework.paginationimportPageNumberPagination
　　fromcommon.customresponseimportCustomResponse
　　classMyPage(PageNumberPagination):
　　page_size=8#每页显示数量
　　max_page_size=50#每页最大显示数量。
　　page_size_query_param='size'#每页数量的参数名称
　　page_query_param='page'#页码的参数名称
　　#自定义分页器的返回参数
　　defget_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
　　returnCustomResponse(data=ret_data,code=200,msg="OK",status=status.HTTP_200_OK)

　　接口访问效果如下：

　　可以看到接口中自定义增加了分页信息，分页的信息数据放在data节点里面了

　　至此，本文介绍了通过Django的restframework接口框架自定义Response返回对象来自定义返回数据格式。Django的restframework接口框架使用简单方便，拿来即用，能够很大程度上减少代码开发量。