如何深入理解ASP.NET Core集成Swagger UI的原理与实现细节？

本文共计2526个文字，预计阅读时间需要11分钟。

Swagger是一种用于描述REST APIs接口功能的规范。在Swagger之前，我们首先介绍OpenApi规范。OpenApi是一种与语言无关的用于描述REST APIs接口功能的规范，它包含以下内容：接口参数信息、接口返回值信息等。

什么是Swagger?

说swagger 之前，我们先说一下OpenApi 规范。

OpenApi 是一种和语言无关的用于描述RESTAPIs 接口功能的一种规范，对RESTAPIs 接口的描述包括： 接口参数信息、接口返回值信息、api 功能描述、请求路径等。

这里我们说OpenApi 只是一种规范，既然是一种规范，就必然有相应的实现，Swagger 就是其中一个实现了Open Api 规范的工具。

.net 中RESTAPIs的代表便是 web api ，并且.net 针对Web Api 也有相应的Swagger 实现，主要有：Swashbuckle 和 NSwag，本文主要讲解如何通过 Swashbuckle库 将SwaggerUI集成到asp.net core项目中去，并快速生成asp.net web api 接口文档。

基本原理分析

在开始进入正题前，我们先看下我的 web api 示例站点中快速集成swagger ui 后的效果，并记住下面提到的 SwaggerUI 界面 和 OpenApi Json 信息 两个关键词，因为后面会多次提到这两个词语。