在 Swagger 中添加 GET 参数答案

【问题标题】：To add GET parameters in Swagger在 Swagger 中添加 GET 参数
【发布时间】：2018-02-08 09:46:41
【问题描述】：

在方法文档中使用django rest framework 和django-rest-swagger，它没有显示可用的GET 参数，问题是如何设置？

代码：

# views.py
@api_view(['GET'])
def tests_api(request):
    """

    :param request:
    :return:
    """
    id = request.query_params.get('id')
    name = request.query_params.get('name')

    return Response({'user': name, 'text': 'Hello world'})

# urls.py
urlpatterns = [
    url(r"^api/v1/tests_api/$", tests_api),
]

http 接口：

GET https://127.0.0.1/api/v1/tests_api/?name=Denis&id=3

HTTP/1.1 200 OK
...
{
    "user": "Denis",
    "text": "Hello world"
}

现在：例子：

Russian 版本。

【问题讨论】：

标签： django django-rest-framework swagger-ui django-rest-swagger

【解决方案1】：

手动声明架构并在此处指定位置为query的字段

  schema = ManualSchema(fields=[
        coreapi.Field(
            "name",
            required=True,
            location="query",
            schema=coreschema.String()
        ),
    ]
  )

见doc for details

【讨论】：

【解决方案2】：

    urlpatterns = [
    url(r'^api/v1/tests_api/(?P<id>\d+)/(?P<name>\w+)/$', tests_api),

]

【讨论】：