DRF项目接入swagger生成接口文档

最新推荐文章于 2024-05-14 23:13:17 发布

白白不白zab

最新推荐文章于 2024-05-14 23:13:17 发布

阅读量172

点赞数

文章标签：开发语言 django

本文链接：https://blog.csdn.net/weixin_43587784/article/details/130582945

版权

1、安装swagger包

pip install drf-yasg

2、配置setting文件

在这里插入图片描述

3、在setting同级目录新建views.py文件配置

from rest_framework import permissions
from drf_yasg.views import get_schema_view
from drf_yasg import openapi
# swagger文档
schema_view = get_schema_view(
    openapi.Info(
        title="API",
        default_version='v1',
        description="系统API文档",
    ),
    public=True,
    permission_classes=(permissions.AllowAny,),
)

4、配置主路由文件urls.py

path('swagger/', schema_view.with_ui('swagger',
                                         cache_timeout=0), name='schema-swagger-ui'),
    path('api_doc/', schema_view.with_ui('redoc',
                                         cache_timeout=0), name='TBoss Api'),