Swagger实现后台接口自动化文档

一、安装

pip install drf-yasg

二、配置

1. 在setting.py中INSTALLED_APPS添加drf-yasg

INSTALLED_APPS = [
	...
    'drf_yasg',
	...
]

2. 在路由中urls中添加

from drf_yasg.views import get_schema_view
from drf_yasg import openapi
from django.conf import settings
from django.conf.urls.static import static

schema_view = get_schema_view(
    openapi.Info(
        title='API接口文档平台',#必传
        default_version="v1", #必传
        description = '这个一接口文档',
        terms_of_service = "",
        contact=openapi.Contact(email='[email protected]'),
        license = openapi.License(name='BSD License'),
    ),
    public = True,
    # permission_classes = (permissions.AllowAny),#权限类py
)

urlpatterns = [
	...
    path('docs/',schema_view.with_ui('swagger',cache_timeout=0),name='schema-swagger-ui'),
    ...
]

urlpatterns += static(settings.MEDIA_URL,document_root = settings.MEDIA_ROOT)