Django, Swagger를 이용한 API 문서화

Django rest framework 프로젝트의 API에 대한 정보를 문서화하려고 합니다.
Swagger를 이용해 자동으로 문서화할 수 있습니다.

Swagger

Swagger는 RESTful 서비스의 설계, 빌드, 문서화, 사용에 도움을 주는 툴입니다.

설치

pip를 이용해 django-rest-swagger를 설치합니다.

$ pip3 install django-rest-swagger

설정

settings.py의 INSTALLED_APPS에 rest_framework_swagger를 추가해줍니다.

# settings.py
...
INSTALLED_APPS = [
    ...
    'rest_framework_swagger',
    ...
]
...

이외의 SWAGGER_SETTINGS에 대한 내용은 Documents를 참고하실 수 있습니다.

URL 설정

프로젝트의 urls.py에 swagger view를 추가합니다.

# urls.py
...
from rest_framework_swagger.views import get_swagger_view
schema_view = get_swagger_view(title="My API")

urlpatterns = [
    ...
    url(r'^$', schema_view),
    ...
]

실행

지정한 url에 접속하면 API가 문서화되어 있고 해당 API를 실행해볼 수 있습니다.