Django Rest Swagger生成api文档

关于swagger

Swagger能成为最受欢迎的REST APIs文档生成工具之一,有以下几个原因:

  • Swagger 可以生成一个具有互动性的API控制台,开发者可以用来快速学习和尝试API。
  • Swagger 可以生成客户端SDK代码用于各种不同的平台上的实现。
  • Swagger 文件可以在许多不同的平台上从代码注释中自动生成。
  • Swagger 有一个强大的社区,里面有许多强悍的贡献者。

下面介绍Swagger生成API文档的具体步骤:

一、安装 django-rest-swagger,进入虚拟环境进行安装

pip instal djangorestframework
pip install django-rest-swagger

二、配置settings.py

INSTALLED_APPS = (
      ....
     'rest_framework',
     'rest_framework_swagger',
     .....
)

三、views.py里的配置

class AdModelRulesViewSet(component_viewsets.ModelViewSet):
    '''
        retrieve:
            Return a group instance.

        list:
            Return all groups,ordered by most recent joined.

        create:
            Create a new group.

        destroy:
            Remove a existing group.

        partial_update:
            Update one or more fields on a existing group.

        update:
            Update a group.
    '''
    queryset = AdModelRules.objects.filter(is_delete=0)
    serializer_class = AdModelRulesSerializer
    permission_classes = (IsAdmin,)

四、urls.py里的配置

# 导入辅助函数
from rest_framework.schemas import get_schema_view
from rest_framework_swagger.renderers import SwaggerUIRenderer, OpenAPIRenderer

schema_view = get_schema_view(title='API',
renderer_classes=[SwaggerUIRenderer, OpenAPIRenderer])

urlpatterns = patterns(
'home_application.views',
(r'^$', 'home'),
(r'^dev-guide/$', 'dev_guide'),
(r'^contactus/$', 'contactus'),
url(r'^', include(router.urls)),
url(r'^docs/$', schema_view, name='docs')
)

五、访问:127.0.0.1/docs/

点击‘Try it do’,即可获取相应的文档

 

posted on 2019-06-28 17:07  yingzi__block  阅读(511)  评论(0编辑  收藏

导航