Django REST FrameworkにSwaggerを簡単に入れれるらしいので試してみたときの備忘録。
インストール
とりあえず、pipでインストール
$ pip install django-rest-swagger
あわせて、settings.pyにも追加&設定
INSTALLED_APPS = ( ... 'rest_framework', 'rest_framework_swagger', ) # 認証ありのAPIもSwaggerUIから使えるように、`LOGIN_URL`とか`DEFAULT_AUTHENTICATION_CLASSES`を設定 LOGIN_URL = 'rest_framework:login' LOGOUT_URL = 'rest_framework:logout' REST_FRAMEWORK = { 'DEFAULT_AUTHENTICATION_CLASSES': ( 'rest_framework_jwt.authentication.JSONWebTokenAuthentication', 'rest_framework.authentication.SessionAuthentication', 'rest_framework.authentication.BasicAuthentication', ), }
URLマッピングを追加
SwaggerUIへのパスをurls.py
に追加。
認証のURLも合わせて追加しておく。
from rest_framework_swagger.views import get_swagger_view schema_view = get_swagger_view(title='API Lists') urlpatterns += [ url(r'^swagger/', schema_view), url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework')) ]
あとは、ブラウザからアクセスするだけ!
http://localhost:8080/swagger
にアクセスすると、APIViewとかからドキュメントを作ってくれます!
便利!
参考になる書籍

- 作者: 関根裕紀,新井正貴
- 出版社/メーカー: シーアンドアール研究所
- 発売日: 2019/07/01
- メディア: 単行本(ソフトカバー)
- この商品を含むブログを見る

- 作者: 掌田津耶乃
- 出版社/メーカー: 秀和システム
- 発売日: 2018/06/09
- メディア: 単行本
- この商品を含むブログを見る

- 作者: 横瀬明仁
- 出版社/メーカー: NextPublishing Authors Press
- 発売日: 2018/08/26
- メディア: オンデマンド (ペーパーバック)
- この商品を含むブログを見る

- 作者: 横瀬明仁
- 発売日: 2018/12/08
- メディア: Kindle版
- この商品を含むブログを見る