django rest framework : swagger


description

  • rest framework で作成した api の一覧を自動生成する.
  • swagger module を用いる

swaggerとは

以下参照されたし
Swaggerの概要をまとめてみた

参考動画

有効化済み path 一覧が表示される

swagger module install

shell
pip install django-rest-swagger

enable swagger

rest_project/settings.py
# 追記
INSTALLED_APPS = [
    ...,
    'rest_framework_swagger',
]

swagger url setting

api/urls.py
# 追記
from rest_framework_swagger.views import get_swagger_view
schema_view = get_swagger_view(title='API Lists')

# 配列へ追記
urlpatterns = [
    ...,
    url(r'^swagger/', schema_view), 
]

open swagger page

shell
python manage.py runserver 0.0.0.0:9000
  • open http://localhost:9000/api/swagger/

以上.