Swagger ドキュメントで API の開発者エクスペリエンスを向上させる

初級
開発者
Azure
Azure CLI
ASP.NET Core

C#/ASP.NET Core で記述された既存の API を、Swashbuckle、Swagger/OpenAPI、Swagger UI を使って文書化する方法を学習します。

学習の目的

このモジュールでは、次のことを行います。

  • Swashbuckle、OpenAPI、Swagger UI について学習する
  • C# または ASP.NET Core API 用に OpenAPI を有効にする
  • C# または ASP.NET Core API で Swashbuckle を使用する
  • OpenAPI で API ドキュメントを生成および表示する

前提条件

  • REST API を設計および実装した経験
  • 基本的な ASP.NET Core アプリを開発した経験
  • .NET SDK のローカル インストール
  • Visual Studio Code
  • Visual Studio Code 用の C# 拡張機能