簡介
記錄您所建置的軟體有許多優點。 經過一段時間後，內容充實的文件不僅可讓您的程式碼更容易維護，也更方便其他人取用。 當其他人想要使用您的 API 時，務必要讓您的程式碼更方便取用。 幸好，提供的工具和架構可讓產生良好文件的成本降低。
假設您是畫框業務的首席開發人員。 您的公司決定公開提供其 API。 許多 API 都沒有任何現有文件，因此您必須負責記錄。 進行記錄，方便合作夥伴正確使用 API，可降低支援和維護成本。
您需要記錄每個 API 的簡單且標準化的方式。 您也需要將文件裝載在合作夥伴可存取位置的方法。
在此課程模組中，您會了解如何使用 Swashbuckle、Swagger、 Swagger UI 和 OpenAPI 記錄現有的 ASP.NET Core API。
學習目標
在本單元中，您將：
- 了解 Swagger、OpenAPI 和 Swagger UI。
- 針對 C#/ASP.NET Core API 啟用 OpenAPI。
- 在 C#/ASP.NET Core API 使用 Swashbuckle。
- 使用 OpenAPI 產生及檢視 API 文件。
必要條件
- REST API 設計與實作的體驗。
- 開發基本 ASP.NET Core 應用程式的體驗。
- .NET Core SDK、Visual Studio Code，以及適用於 Visual Studio Code 的 C# 延伸模組的本機安裝。