DRF中配置drf-yasg来使用swagger

不起眼的程序猿

已于 2022-03-16 22:43:59 修改

阅读量1k

点赞数

分类专栏： drf swagger 文章标签： python

于 2021-08-18 21:04:39 首次发布

本文链接：https://blog.csdn.net/qq_38977315/article/details/119788978

版权

drf 同时被 2 个专栏收录

5 篇文章

订阅专栏

swagger

3 篇文章

订阅专栏

本文介绍了如何在Django Rest Framework (DRF)项目中集成drf-yasg，详细步骤包括设置Swagger配置、添加URL路由，以及生成交互式的API文档。通过配置，API用户可以方便地查看API接口、参数和授权信息。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

DRF中配置drf-yasg来使用swagger

简单使用，具体配置根据项目需求，安装drf-yasg并注册到app省略

在settings.py中做如下配置

# -----------------------------------------swagger配置-------------------------------------------
SWAGGER_SETTINGS = {
    'LOGIN_URL': '/api-auth/login/',
    'LOGOUT_URL': '/api-auth/logout/',
    'PERSIST_AUTH': True,
    'REFETCH_SCHEMA_WITH_AUTH': True,
    'REFETCH_SCHEMA_ON_LOGOUT': True,

    'DEFAULT_INFO': 'DjangoDrfTest.urls.swagger_info',#这里注意，更改DjangoDrfTest

    'SECURITY_DEFINITIONS': {
        'Basic': {
            'type': 'basic'
        },
        'Bearer': {
            'type': 'apiKey',
            'name': 'authorization',
            'in': 'header'
        },
        'Query': {
            'type': 'apiKey',
            'name': 'auth',
            'in': 'query'
        }
    }
}
# -----------------------------------------------------------------------------------------------

在urls.py中加入如下代码

schema_view = get_schema_view(
    openapi.Info(
        title="Snippets API",
        default_version='v1',
        description="Test description",
        terms_of_service="https://www.google.com/policies/terms/",
        contact=openapi.Contact(email="contact@snippets.local"),
        license=openapi.License(name="BSD License"),
    ),
    public=True,
    permission_classes=[permissions.AllowAny],
)
# 在urlpatterns中加入如下
urlpatterns = [
    re_path(r'^admin/', admin.site.urls),
    re_path(r'^$', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
    re_path(r'^swagger(?P<format>\.json|\.yaml)$', schema_view.without_ui(cache_timeout=0), name='schema-json'),
    re_path(r'^swagger/$', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
    re_path(r'^redoc/$', schema_view.with_ui('redoc', cache_timeout=0), name='schema-redoc'),
    url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework')),
    path('api/article/', include('article.urls', namespace='article'))
]