简介

  • 2 分钟

记录构建的软件有诸多益处。 可靠的文档不仅可使代码随着时间推移更易于维护，还可使其更容易被其他人使用。 当拥有其他人想要使用的 API 时，让你的代码更易于使用尤其重要。 幸运的是，有一些工具和框架可以降低生成好文档的成本。

假设你是打印框架业务的首席开发人员。 你的公司决定公开发布其 API。 许多 API 没有现有文档，而你负责编写文档。 编写 API 文档会使合作伙伴更容易正确使用 API，从而降低支持和维护成本。

你需要一种简单且标准化的方式来记录每个 API。 还需要一种方法将文档托管在合作伙伴可访问的位置。

本模块介绍如何使用 Swashbuckle、Swagger、Swagger UI 和 OpenAPI 来记录现有的 ASP.NET Core API。

学习目标

在本模块中，你将：

  • 了解 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# 扩展的本地安装。