まとめ

完了

API の内容豊富なドキュメントにより、API の使用とメンテナンスが容易になります。 このモジュールの例では、Swashbuckle と Swagger を使用して、ASP.NET Core API の OpenAPI ドキュメントを自動生成しました。

Swashbuckle パッケージをプロジェクトに追加すると、プロフェッショナルな OpenAPI ドキュメントが得られます。 Swagger UI により、OpenAPI ドキュメントが読みやすくなり、利用者が API のソース コードを知る必要がなくなります。

また、XML コメントと注釈を通して既定の Swagger ドキュメントを拡張する方法も学習しました。

詳細情報