はじめに
構築するソフトウェアを文書化すると多くの利点があります。 しっかりしたドキュメントを作成しておくと時間が経ってもコードをメンテナンスしやすいだけでなく、他の開発者が使用するのも容易になります。 コードを使いやすくすることは、他の開発者が使いたい API がある場合に特に重要です。 さいわい、優れたドキュメントの作成コストを下げるために使用できるツールとフレームワークがあります。
あなたは印刷フレーム ビジネスの開発リーダーです。 あなたの会社は API を公開することにしました。 API の多くには既存のドキュメントがなく、あなたの役割はそれらを文書化することです。 API を文書化すると、パートナーがそれらを正しく使用するのが容易になり、サポートとメンテナンスのコストが下がります。
各 API を文書化するための簡単で標準化された方法が必要です。 また、パートナーがアクセスできる場所でドキュメントをホストする方法も必要です。
このモジュールでは、既存の ASP.NET Core API を、Swashbuckle、Swagger、Swagger UI、OpenAPI を使って文書化する方法を学習します。
学習の目的
このモジュールでは、次のことを行います。
- 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# 拡張機能のローカル インストール。