Swaggerプラグイン

Swaggerプラグインについて

Swaggerプラグインを使用すると、サーバーにSwaggerUIのエンドポイントが追加されます。
SwaggerUIを利用することで、クライアントを介さずにAPIの挙動が確認出来、特にサーバーのソースを改修する際の確認に最適です。
Swaggerプラグインはプロジェクト作成時にデフォルトで有効になっているため、有効にする際の手順はありませんが、リリース時等に無効にしたい場合はプラグイン設定から無効にする必要があります。

Swaggerプラグインの有効化 (無効化)

プラグイン設定にて、Swaggerプラグインを有効または無効にしてください。
なお、APIの公開を防ぐためリリースの際には無効にすることをお勧めします。

SwaggerUIの使い方

プロジェクトのホーム画面の『→ SwaggerUIに移動』から利用できます。
詳細な使い方はSwaggerUIの公式ページをご確認ください。