如何在Django 2.x的drf-yasg中使用自定义方法创建API（类似于swagger）？

Question

我正在将我的Django 1.11.7迁移到2.x版本。其中一个问题是django-rest-swagger已被弃用，现在应该使用drf-yasg来进行API文档和创建。我需要以创建自定义API的相似方式来做到这一点，以便不会破坏移动设备上的任何内容。

以前是这样的（django-rest-swagger==2.1.1）

这里是在Django 1.11.7和django-rest-swagger==2.1.1中运行良好的旧代码片段：

using swagger_schema.py
https://gist.github.com/axilaris/2f72fef8f30c56d5befe9e31cd76eb50


in url.py:

from rest_framework_swagger.views import get_swagger_view
from myapp.swagger_schema import SwaggerSchemaView


urlpatterns = [  
   url(r'^swaggerdoc/', SwaggerSchemaView.as_view()),
   url(r'^api/v1/general/get_countries$', api.get_countries, name='get_countries'),


in api.py:
@api_view(['POST'])
def get_countries(request):
    # ----- YAML below for Swagger -----
    """
    description: countries list
    parameters:
      - name: token
        type: string
        required: true
        location: form   
    """
    ......
    return Response(countries_list, status=status.HTTP_200_OK)

我的问题是如何在drf-yasg上实现类似的操作，因为我想迁移这段代码而不会影响移动端。

可能会尝试在最新的稳定版本上进行操作：

djangorestframework==3.9
drf-yasg==1.16.1

- Axil

Answer 1

你可以在api.py中像这样做。这将生成与你在截图中显示的完全相同的内容：

from drf_yasg import openapi
from drf_yasg.utils import swagger_auto_schema

from rest_framework.decorators import api_view, parser_classes
from rest_framework.parsers import FormParser

token = openapi.Parameter('token', openapi.IN_FORM, type=openapi.TYPE_STRING, required=True)


@swagger_auto_schema(
    method="post",
    manual_parameters=[token]
)
@api_view(["POST"])
@parser_classes([FormParser])
def get_countries(request):
    """
    Countries list
    """
    ......
    return Response(countries_list, status=status.HTTP_200_OK)

请注意，我添加了@parser_classes（[FormParser]）装饰器，以确保视图接受表单数据。如果您的所有端点仅使用表单数据工作，则可以将其删除，并在DRF设置中全局设置它。

结果： 这里有更多关于@swagger_auto_schema装饰器的文档。

- AArias

---

非常出色！谢谢。我想再问一个稍微深入的问题，如何处理文件上传？之前我是这样做的 https://gist.github.com/axilaris/779f8cc88a4f5fadbf4fd3b88006c4f3。文件应该给出哪些参数？ - Axil

@Axil 在令牌下声明参数，就像这样：company_logo = openapi.Parameter('company_logo', openapi.IN_FORM, type=openapi.TYPE_FILE, required=True)，然后将其添加到装饰器内的 manual_parameters 列表中，如下所示：manual_parameters=[token, company_logo]。这是相同的事情，只是您必须使用 openapi.TYPE_FILE 而不是 TYPE_STRING。 - AArias