Django 프로젝트에 Swagger 적용하기

Swagger은 API개발을 보다 쉽게 관리하고 문서화하는 데 사용되는 프레임 워크로 API를 빠르게 디자인, 빌드, 문서화하고 테스트할 수 있습니다.

 

 

 

Swagger 설치

스웨거를 적용하는 패키지는 여러개 있지만 대표적으로 현재까지 잘 작동하는 것은 drf-yasg 패키지입니다.

아래 명령어를 통해서 설치할 수 있습니다.

pip install drf-yasg

저는 가상환경(pipenv)에서 진행하기 때문에 아래 명령어로 다운로드하여주었습니다.

pipenv install drf-yasg

 

 

 

settings.py 

settings.py파일에 INSTALLED_APP에 drf-yasg를 추가해 줍니다.

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

 

 

 

urls.py

urls.py에 swagger 기능을 추가해 줍니다.

from drf_yasg.views import get_schema_view
from drf_yasg import openapi
from rest_framework.permissions import AllowAny

schema_view = get_schema_view(
    openapi.Info(
        title="weheproject API",  # 타이틀
        default_version='v1',   # 버전
        description="API for weheproject",   # 설명
        terms_of_service="API약관",
        contact=openapi.Contact(email="이메일") # 입력하지않고 삭제해도 되는 부분
    ),
    public=True,
    permission_classes=(AllowAny,)
)

 

 

 

웹 브라우저에서 확인

이제 서버를 실행하고 웹 브라우저에서 "http://localhost:8000/swagger"로 접속하면 Swagger UI페이지를 확인할 수 있습니다.