Django Rest Framework:如何为基于函数的视图启用swagger文档 [英] Django Rest Framework: How to enable swagger docs for function based views

问题描述

我浏览了 Django REST Swagger 2.1.2文档.当我尝试基于类的视图时，它运行良好.

I went through Django REST Swagger 2.1.2 documentation. When I tried with class based views, it was working fine.

但是我没有找到有关如何为基于函数的视图启用摇动的任何参考，如下所示:

But i did not find any reference on how to enable swagger for function based views as shown below:

@api_view(['GET', 'POST'])
def app_info(request): 
    ...
    return response

我的大多数views.py都充满了基于函数的视图，就像上面一样.

Most of my views.py is filled with function based views, just like above.

任何有关如何启用该功能的帮助将不胜感激.谢谢！

Any help on how to enable the same will greatly appreciated. Thanks!

我正在使用 Django:1.8； Django REST Swagger:2.1.2; DRF:3.6.2

推荐答案

您应该可以使用

You should be able to use @renderer_classes decorator:

from rest_framework_swagger import renderers
from rest_framework.decorators import api_view, renderer_classes


@api_view(['GET', 'POST'])
@renderer_classes([renderers.OpenAPIRenderer, renderers.SwaggerUIRenderer])
def app_info(request): 
    ...
    return response

另外，值得一提的是，如果您不想在每个视图上都使用此装饰器，则可以指定

Also, it should be worth mentioning, that if you don't want to use this decorator on every view you can specify DEFAULT_RENDERER_CLASSES in settings

看来它毕竟在文档中.检查此页面的最底部: https://django-rest-swagger. readthedocs.io/en/latest/schema/

It seems it's in the docs after all. Check the very bottom of this page: https://django-rest-swagger.readthedocs.io/en/latest/schema/

这篇关于Django Rest Framework:如何为基于函数的视图启用swagger文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！