django-rest-framework解析请求参数

解析django-rest-framework的请求参数

# 前言

前面的文章中编写了接口, 调通了接口文档. 接口文档可以直接填写参数进行请求, 接下来的问题是如何接受参数, 由于请求方式与参数序列化形式的不同, 接收参数的方式也有不同.

# 前提条件

服务端我们使用django-rest-framework编写接口.

    class ReturnJson(APIView):

        coreapi_fields=(
            DocParam("token"),
        )

        def get(self, request, *args, **kwargs):
            return JsonResponse("Hello world!!!!!!!!++++++中文测试")

这是一个简单接口, ReturnJson 继承自 APIView
而 APIView 来自 from rest_framework.views import APIView

以下 def get, def post 等等的前提条件都是接口类继承自 APIView.
当然还可以继承自其它的类例如.

from rest_framework import viewsets, generics

    class ReturnJson(generics.ListCreateAPIView)
    class ReturnJson(viewsets.ModelViewSet)

他们的用法各有特点, 详情查看
http://www.django-rest-framework.org/api-guide/viewsets/
http://www.django-rest-framework.org/api-guide/generic-views/
http://www.django-rest-framework.org/api-guide/views/

# django-rest-framework 如何编写一个接口.

    class ReturnJson(APIView):

        coreapi_fields=(
            DocParam("token"),
        )

        def get(self, request, *args, **kwargs):
            return JsonResponse("Hello world!!!!!!!!++++++中文测试")

        def post(self, request, *args, **kwargs):
            return JsonResponse(data={})
        
        def put(self, request, *args, **kwargs):
            return JsonResponse(data={})

对一个 APIView 的子类, 重写 get, post, put 等方法就相当于解析这个路径的 get, post, put 请求, 请求对象就是 request 对象, http header body 的内容都被包含在 request 对象中.
request 对象的类来自 from rest_framework.request import Request 判断对象是否是某个类实例化而来

    from rest_framework.request import Request
    if isinstance(request, Request)

下面分别分析不同情况的参数位置和类型, 最终写出一个方法能够将任何类型的请求参数统一转换为 dict 方便之后的逻辑编写.

# GET

get 请求中参数都会以http://xxx.com/api/getjson?param1=asdf¶m2=123
这样的形式拼接在 url 后面.

在 request 对象中

request.query_params 中可以获取 ? param1=32¶m2=23 形式的参数.
request.query_params 返回的数据类型为 QueryDict
QueryDict 转为普通 python 字典. query_params.dict() 即可.

# POST

post 请求参数都在请求体中, 但是其实你的 url 可以写成 get 的形式, 最终结果, 参数会有两部分组成, 一部分在 url 中, 一部分在 http body 中, 但是非常不建议这样做.

接下来的代码编写也不会考虑这样的情况, post 仅考虑所有参数都在 http body 中的情况.

提交类型	参数位置	参数类型
form-data 提交,	参数在 data 中,	类型为 QueryDict
application/json 提交	参数在 data 中	类型为 dict
(swagger) 使用接口文档提交, 由于使用 curl 提交, 虽然是 post 但是参数依然被类似 get 的形式拼接到了 url 之后,	此时参数在 query_params 中	类型为 QueryDict
x-www-form-urlencoded	参数在 data 中	类型为 QueryDict

# PUT

提交类型	参数位置	参数类型
form-data	request.data	QueryDict
application/json	request.data	dict
x-www-form-urlencoded	request.data	QueryDict
(swagger)	request.data	dict

# PATCH

提交类型	参数位置	参数类型
form-data	request.data	QueryDict
application/json	request.data	dict
x-www-form-urlencoded	request.data	QueryDict
(swagger)	request.data	dict

# DELETE

提交类型	参数位置	参数类型
form-data	request.data	QueryDict
application/json	request.data	dict
x-www-form-urlencoded	request.data	QueryDict
(swagger)	request.query_params	QueryDict
iOS 端提交和 get 情况一样	request.query_params	QueryDict

# 编写参数统一处理的方法

总结一下, 当 url 有? param=1¶m=2 这样的参数时忽略 body 中的参数, 例如 get,delete 提交, 如果 query_params 有内容, 则忽略 body 内容. 将 QueryDict 转为 dict 返回, 再判断 request.data 中是否有内容, 类型如何.

    from django.http import QueryDict
    from rest_framework.request import Request
    def get_parameter_dic(request, *args, **kwargs):
        if isinstance(request, Request) == False:
            return {}

        query_params = request.query_params
        if isinstance(query_params, QueryDict):
            query_params = query_params.dict()
        result_data = request.data
        if isinstance(result_data, QueryDict):
            result_data = result_data.dict()

        if query_params != {}:
            return query_params
        else:
            return result_data

使用方法

    class ReturnJson(APIView):

        coreapi_fields=(
            DocParam("token"),
        )

        def get(self, request, *args, **kwargs):
            params=get_parameter_dic(request)
            return JsonResponse(data=params)

        def post(self, request, *args, **kwargs):
            params=get_parameter_dic(request)
            return JsonResponse(data=params)

        def put(self, request, *args, **kwargs):
            params=get_parameter_dic(request)
            return JsonResponse(data=params)

最后的效果

最终效果. png