如何记录基于函数的视图参数?

Gui*_*TeK 5 django python-3.x swagger django-rest-framework django-swagger

我正在使用 Django 1.11 和 Django REST Framework 3.7 开发 REST API。我安装了Django REST Swagger 2.1 来生成文档。

我正在使用这样的基于函数的视图:

from rest_framework.decorators import api_view, permission_classes

@api_view(['POST'])
@permission_classes((permissions.AllowAny,))
def jwt_auth(request, provider, format=None):
    """
    View description here
    """
    pass
Run Code Online (Sandbox Code Playgroud)

Swagger 生成的文档

如您所见,我的视图被 Swagger 识别,并且具有正确的描述:“在此处查看描述”。

然而:

  • 您可以看到URL 参数的“说明”列为空provider
  • POST 参数没有记录(显然,因为 Swagger 无法知道它们)

如何为基于函数的视图的 URL 和 POST 参数以及响应编写文档?

我尝试了YAML Docstrings,但它似乎适用于旧版本 (0.3.x),并且不适用于 2.x 版。

Clé*_*oix 1

在这个github 问题之后,您所说的基于方法的视图似乎是不可能的。

但我认为这个链接可以帮助你。