인터페이스 문서를 생성하기 위한 DRF 프로젝트 액세스 스웨거

1. swagger 패키지 설치

pip install drf-yasg

2. 설정 파일 구성

3. 같은 수준의 설정 디렉토리에 새 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'),

스웨거를 방문하다