.NETラボ2022年5月 BlazorにSwaggerを導入してみよう

1. BlazorにSwaggerを導
入してみよう
株式会社SAKURUG
エンジニアリングユニット
草場 友光
.NET ラボ 2022年5月

2. 自己紹介
• 普段は主にWebFormsアプリ
の保守のお仕事をしてます。
• 古めのシステムが多いので時
代に取り残されぬよう新しい技
術を一つでも入れるよう日々努
力しています。
• tomo_kusaba

3. 宣伝
【VISION】ひとの可能性を開花させる企業であり続ける
VISIONに共感できる仲間募集中。

4. 注意
• 個人の見解・解釈が多分に入っています。
• 見解の相違・事実誤認などありましたらご指摘ください。
• #dotnetlabでtweetすると右側に表示されます

5. 今日の目的
• Blazor WebAssembly ではREST APIサーバの構築が不可欠で
す。
• REST APIの単体テストに不可欠なSwaggerの導入と簡単な利
用法について紹介します。
• 今回は、ユースケースとしてBlazor WebAssembly ASP.NET
Core Hostedのパターンで導入をしてみます。

6. Swaggerとは
• SwaggerとはOpenAPI仕様を使用するツール
• たとえば、OpenAPIGeneratorやSwagger UIなど

7. Swagger UI
• OpenAPIの仕様を利用してサービスに関する情報がWebベー
スのUIで提供されている
• コントローラの各パブリックアクションメソッドをUIからテス
トすることができる

8. Swashbuckleとは
• .NETでのSwagger実装
• SwaggerDocumentオブジェクトを構築するSwaggerジェネ
レータやSwagger UIツールが提供される

9. Swashbuckleの導入手順
• 「Swashbuckle.AspNetCore」パッケージをNuget

10. Swashbuckleの
導入手順２
• Serverプロジェクトの
Program.csでSwaggerジェ
ネレータをサービスコレク
ションに追加
• 生成されたJSONドキュメン
トとSwagger UI対応のミド
ルウェアを有効にします

11. 実行結果

12. Swashbuckleのカスタマイズと拡張
APIと情報説明
OpenApiInfoクラスを使用してUIに表示され
る情報を変更する

13. Swashbuckleのカスタマイズと拡張
XMLコメント
XMLコメントを有効
化
XMLファイルを使用するよう
にSwaggerを構成

14. Swashbuckleのカスタマイズと拡張
XMLコメント実行結果

15. デモ

16. 参考文献
• Swagger/OpenAPI を使用する ASP.NET Core Web API の
ドキュメント
• Swashbuckle と ASP.NET Core の概要
• Swagger ドキュメントで API の開発者エクスペリエンスを向
上させる

17. おしまい
おしまい