DRF プロジェクトにアクセスしてインターフェイス ドキュメントを生成する Swagger

1. Swagger パッケージをインストールする

pip install drf-yasg

2. 設定ファイルを設定する

3. 同じレベルの設定ディレクトリに新しい views.py ファイル構成を作成します

from rest_framework import permissions
from drf_yasg.views import get_schema_view
from drf_yasg import openapi
# swagger文档
schema_view = get_schema_view(
    openapi.Info(
        title="API",
        default_version='v1',
        description="系统API文档",
    ),
    public=True,
    permission_classes=(permissions.AllowAny,),
)

4. メインルーティングファイル urls.py を設定します。

path('swagger/', schema_view.with_ui('swagger',
                                         cache_timeout=0), name='schema-swagger-ui'),
    path('api_doc/', schema_view.with_ui('redoc',
                                         cache_timeout=0), name='TBoss Api'),

訪問