파이썬 django drf-yasg 스웨거 연동

• 터미널에서 drf-yasg 패키지를 설치한다

pip install drf-yasg

• settings.py 파일의 INSTALLED_APPS에 추가해준다.

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

• 해당앱의 디렉터리.views.py 파일 안의 api 메소드 위에 swagger_auto_schma를 달아준다

# @swagger_auto_schema(method='메소드', request_body='serializers의 클래스 명'
@swagger_auto_schema(method='post', request_body=BoardCreateSerializer)

• 맨 처음 만들어지는 앱 디렉터리의 urls.py 파일에 해당 코드를 입력한다.

# import 같은 경우 아래에 schema_view 코드를 넣고나서 
# 빨간 줄에 커서를 올려서 편하게 import 가능
from drf_yasg import openapi
from drf_yasg.views import get_schema_view
from rest_framework import permissions

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 = [
	...
		path('swagger/', schema_view.without_ui(cache_timeout=0), name='schema-json'),
    path('swagger/', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
    path('redoc/', schema_view.with_ui('redoc', cache_timeout=0), name='schema-redoc'),
	...
]

들어가면 이렇게 설정한 serializers model과 함께 뜬다.