asp.net core 集成swagger ui的原理解析

更新時(shí)間：2021年10月08日 08:56:47 作者：chenxin.dm

本文主要講解了如何對(duì)API進(jìn)行分組，這里僅僅是舉了一個(gè)按照API功能進(jìn)行分組的例子，其實(shí)在實(shí)際開發(fā)中，要按照何種方式分組，可以按照需求靈活定義，比如按照API版本進(jìn)行分組

什么是Swagger?

說(shuō)swagger 之前，我們先說(shuō)一下OpenApi 規(guī)范。

OpenApi 是一種和語(yǔ)言無(wú)關(guān)的用于描述RESTAPIs 接口功能的一種規(guī)范，對(duì)RESTAPIs 接口的描述包括：接口參數(shù)信息、接口返回值信息、api 功能描述、請(qǐng)求路徑等。

這里我們說(shuō)OpenApi 只是一種規(guī)范，既然是一種規(guī)范，就必然有相應(yīng)的實(shí)現(xiàn)，Swagger 就是其中一個(gè)實(shí)現(xiàn)了Open Api 規(guī)范的工具。

.net 中RESTAPIs的代表便是 web api ，并且.net 針對(duì)Web Api 也有相應(yīng)的Swagger 實(shí)現(xiàn)，主要有：Swashbuckle 和 NSwag，本文主要講解如何通過(guò) Swashbuckle庫(kù) 將SwaggerUI集成到asp.net core項(xiàng)目中去，并快速生成asp.net web api 接口文檔。

基本原理分析

在開始進(jìn)入正題前，我們先看下我的 web api 示例站點(diǎn)中快速集成swagger ui 后的效果，并記住下面提到的 SwaggerUI 界面和 OpenApi Json 信息兩個(gè)關(guān)鍵詞，因?yàn)楹竺鏁?huì)多次提到這兩個(gè)詞語(yǔ)。

SwaggerUI 界面如下圖：

OpenApi Json 信息如下（該Json信息描述了web api 所有接口，按照OpenApi規(guī)范生成）：

大致的原理就是，當(dāng)我們?yōu)g覽器中輸入：http://localhost:5000/swagger/index.html 請(qǐng)求SwaggerUI 頁(yè)面，SwaggerUI 中間件攔截到這個(gè)請(qǐng)求后，讀取內(nèi)置SwaggerUI 頁(yè)面內(nèi)容并響應(yīng)給瀏覽器,瀏覽器再發(fā)起一個(gè)異步請(qǐng)求去請(qǐng)求OpenApi Json 信息，然后根據(jù)OpenApi Json 信息生成上面第一張圖中所有的接口信息，我們可以通過(guò)瀏覽器的開發(fā)人員工具看到這個(gè)請(qǐng)求。

OK，了解完SwaggerUI 的基本原理后，下面我們來(lái)講解如何快速將SwaggerUI 集成到 Web Api 項(xiàng)目中去。

安裝swagger相關(guān)nuget包

在需要集成swagger的項(xiàng)目中安裝nuget 包：Swashbuckle.AspNetCore

注入SwaggerAPI文檔生成服務(wù)，添加SwaggerUI 響應(yīng)中間件

打開SwaggerDemo下的Startup.cs文件，修改Configuservice 方法，將API文檔生成服務(wù)添加到依賴注入容器中。

  public void ConfigureServices(IServiceCollection services)
        {
            //這里將OpenApi Json 信息生成服務(wù)添加到依賴注入容器中，負(fù)責(zé)根據(jù)web api 的定義生成相應(yīng)的OpenApi Json 信息。
            services.AddSwaggerGen();
            services.AddControllersWithViews();
        }

修改Startup.cs 下的 Configure 方法，將Swagger UI 請(qǐng)求攔截中間件、OpenApi Json 信息請(qǐng)求攔截中間件加入到請(qǐng)求中間件管道列表中去。

 public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
        {
            if (env.IsDevelopment())
            {
                app.UseDeveloperExceptionPage();
            }
            else
            {
                app.UseExceptionHandler("/Home/Error");
            }
            app.UseStaticFiles();
            //UseSwagger添加了一個(gè)中間件，這個(gè)中間件主要是攔截 瀏覽器中發(fā)送過(guò)來(lái)的 獲取OpenApi Json 信息的HTTP請(qǐng)求，并把WebApi 描述信息返回給SwaggerUI，上圖中，我么可以看到默認(rèn)請(qǐng)求OpenApi Json 信息的http地址是：http://localhost:5000/swagger/v1/swagger.json
            app.UseSwagger();
            
            //UseSwaggerUI 添加了一個(gè)中間件，主要用于攔截SwaggerUI界面的訪問(wèn)請(qǐng)求，并根據(jù)OpenApi Json 信息動(dòng)態(tài)生成接口列表，在上面的基本原理講述中，默認(rèn)請(qǐng)求SwaggerUI 界面的http地址是：http://localhost:5000/swagger/index.html
            app.UseSwaggerUI((options) =>
            {
                //SwaggerEndPoint 方法用于告訴SwaggerUI 請(qǐng)求哪個(gè)地址來(lái)獲取OpenApi Json 信息，后面我們會(huì)講解如何自定義這個(gè)路徑。
                options.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
            });

            app.UseRouting();

            app.UseAuthorization();

            app.UseEndpoints(endpoints =>
            {
                endpoints.MapControllerRoute(
                    name: "default",
                    pattern: "{controller=Home}/{action=Index}/{id?}");
            });
        }

OK，至此，SwaggerUI 就已經(jīng)集成到了我們的WebApi 項(xiàng)目中去了，如果不出意外，那么可以正常看到我上面基本原理分析中提到的效果圖了，是不是很簡(jiǎn)單，下面我們來(lái)講解一些更深入一些的用法。

如何自定義OpenApi Json 信息請(qǐng)求Http地址?

默認(rèn)OpenApi Json 信息的請(qǐng)求地址為：/swagger/v1/swagger.json,如果我們想換成其他地址，比如改成：/BlogApis/v1/swagger.json 該如何操作呢？

首先配置攔截SwaggerUI界面請(qǐng)求的中間件，告訴SwaggerUI 從哪個(gè)地址去請(qǐng)求獲取 OpenApi Json 信息。

app.UseSwaggerUI((options) =>
{
      //options.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
      //這里告訴SwaggerUI從/BogApis/v1/swagger.json 獲取 OpenApi Json 信息。
        options.SwaggerEndpoint("/BlogApis/v1/swagger.json", "BlogApis");
});

然后配置攔截OpenAPI Json 信息的中間件，重新定義OpenApi Json信息的請(qǐng)求路徑格式，如下：

app.UseSwagger(swaggerOptions =>
{
       //告訴OpenApi Json 信息請(qǐng)求攔截中間件，收到以下格式的請(qǐng)求時(shí)返回OpenApi Json信息
       //注意：路徑中必須包含: {documentName}，Swagger 中間件從請(qǐng)求路徑中{documentName}占位符位置提取出api 文檔名稱，以便顯示分組到該文檔名稱下的 
       //所有api信息。
       swaggerOptions.RouteTemplate = "/BlogApis/{documentName}/swagger.json";
});

順便提一下，通過(guò)查看Swagger 源碼，我們可以看到默認(rèn)的OpenApi Json解析路由就是 swagger/{documentName}/swagger.json ，這就是為什么我們一開始默認(rèn)必須使用 /swagger/v1/swagger.json 格式去請(qǐng)求OpenApi Json 信息的原因。

如何在SwaggerUI 中分組展示指定的API?

上面我們?cè)?OpenApi Json 請(qǐng)求地址的解析路由中提到了必須包含{documentName}參數(shù)，比如：/BlogApis/{documentName}/swagger.json,同時(shí)上面也提到了OpenApi Json 信息請(qǐng)求地址和這個(gè)路由是一一對(duì)應(yīng)的，如：我們上面定義的OpenApi Json 信息的請(qǐng)求地址是：/BlogApis/v1/swagger.json，當(dāng)瀏覽器訪問(wèn)SwaggerUI 頁(yè)面并請(qǐng)求 /BlogApis/v1/swagger.json 地址時(shí)，根據(jù)路由模板：/BlogApis/{documentName}/swagger.json 從OpenApi Json 請(qǐng)求地址的第二段中提取出v1作為 api 文檔名稱，然后默認(rèn)加載出所有分組名稱為 v1 或者未定義分組名稱的API 信息，并顯示，那么我們?nèi)绾瓮ㄟ^(guò)documentName 對(duì)api 進(jìn)行分組展示呢？

打開Startup.cs ,找到 ConfigureServices 方法，添加如下代碼：

  services.AddSwaggerGen(options =>
            {
                //這里我們將用戶相關(guān)的API分成一組,這里的User就是文檔名稱(documentName)
                options.SwaggerDoc("User", new Microsoft.OpenApi.Models.OpenApiInfo()
                {
                    Title = "用戶管理",
                    Version = "1.0"
                });
                //這里我們將文章管理相關(guān)的API分成一組。
                options.SwaggerDoc("Post", new Microsoft.OpenApi.Models.OpenApiInfo()
                {
                    Title = "文章管理",
                    Version = "1.0"
                });
                //以下是設(shè)置SwaggerUI中所有Web Api 的參數(shù)注釋、返回值等信息從哪里獲取。
                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                options.IncludeXmlComments(xmlPath);
            });

找到Configure方法，按照如下配置：

 app.UseSwaggerUI((options) =>
            {
                //options.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
                //options.SwaggerEndpoint("/BlogApis/v1/swagger.json", "BlogApis");

                //定義用戶管理相關(guān)API的OpenApi Json 信息請(qǐng)求路徑。
                options.SwaggerEndpoint("/BlogApis/User/swagger.json", "UserManagerApis");
                //定義文章管理相關(guān)API的OpenApi Json 信息請(qǐng)求路徑。
                options.SwaggerEndpoint("/BlogApis/User/swagger.json", "PostManagerApis");
            });

分別在UserController 、 PostController 上面添加 [ApiExplorerSettings]特性，并設(shè)置分組名稱

[Route("api/[controller]"), ApiExplorerSettings(GroupName = "User")]
    [ApiController]
    public class UserController : ControllerBase
    {
        /// <summary>
        /// 用戶登錄
        /// </summary>
        /// <param name="userName">用戶名</param>
        /// <param name="password">密碼</param>
        /// <returns></returns>
        [HttpPost]
        [ProducesResponseType(200, Type = typeof(UserInfo))]
        public UserInfo Login([FromForm] string userName, [FromForm] string password)
        {
            if (userName == "chenxin" && password == "123456")
            {
                return new UserInfo() { UserName = "chenxin", Age = 31 };
            }
            return null;
        }

        [HttpGet]
        public List<UserInfo> GetAllUsers()
        {
            return new List<UserInfo>()
            {
                new UserInfo()
                {
                    UserName="chenxin",
                    Age=31
                },
                new UserInfo()
                {
                    UserName="zhangsan",
                    Age=35
                }
            };
        }

 [Route("api/{controller}")]
    [ApiExplorerSettings(GroupName = "Post")]
    public class PostController : ControllerBase
    {
        /// <summary>
        /// 獲取所有文章
        /// </summary>
        /// <returns></returns>
        [HttpGet]
        public List<Post> GetAllPosts()
        {
            return new List<Post> { new Post()
            {
                Title="測(cè)試文章",
                Content="測(cè)試內(nèi)容..."
            } };
        }
    }
    public class Post
    {
        public string Title { get; set; }
        public string Content { get; set; }
        public DateTime PublishTime { get; set; } = DateTime.Now;
    }

按照上述步驟操作完成后，我們可以看到已經(jīng)實(shí)現(xiàn)了API的分組。

好了，問(wèn)題來(lái)了，為什么默認(rèn)沒有使用SwaggerDoc 方法定義任何文檔名稱默認(rèn)也能找到API信息呢，其實(shí)還是Swagger 中間件默認(rèn)給我們?cè)黾恿艘粋€(gè)名為v1的文檔。

如何自定義SwaggerUI的請(qǐng)求路徑?

如果不想輸入 swagger/index.html 來(lái)訪問(wèn)swaggerui ，比如想改成 /BlogApisDocs,打開Startup.cs 找到 Configure 方法，添加如下代碼：

   app.UseSwaggerUI((options) =>
            {
                //options.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
                //options.SwaggerEndpoint("/BlogApis/v1/swagger.json", "BlogApis");

                //定義用戶管理相關(guān)API的OpenApi Json 信息請(qǐng)求路徑。
                options.SwaggerEndpoint("/BlogApis/User/swagger.json", "UserManagerApis");
                //定義文章管理相關(guān)API的OpenApi Json 信息請(qǐng)求路徑。
                options.SwaggerEndpoint("/BlogApis/User/swagger.json", "PostManagerApis");

                //這里我們告訴SwaggerUI 請(qǐng)求攔截中間件，當(dāng)收到瀏覽器發(fā)送過(guò)來(lái)的/BlogApisDocs 的請(qǐng)求則返回SwaggerUI 頁(yè)面。
                options.RoutePrefix = "BlogApisDocs";
            });

如何將API 方法注釋、參數(shù)注釋自動(dòng)通過(guò)SwaggerUI展示？

打開Startup.cs 找到 ConfigureServices方法增加如下代碼：

   services.AddSwaggerGen(options =>
            {
                //這里我們將用戶相關(guān)的API分成一組。
                options.SwaggerDoc("User", new Microsoft.OpenApi.Models.OpenApiInfo()
                {
                    Title = "用戶管理",
                    Version = "1.0"
                });
                //這里我們將文章管理相關(guān)的API分成一組。
                options.SwaggerDoc("Post", new Microsoft.OpenApi.Models.OpenApiInfo()
                {
                    Title = "文章管理",
                    Version = "1.0"
                });
                //以下是設(shè)置SwaggerUI中所有Web Api 的參數(shù)注釋、返回值等信息從哪里獲取。
                //這里表示從站點(diǎn)根目錄下的指定XML配置文件中去讀取API的注釋信息。
                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                options.IncludeXmlComments(xmlPath);
            });

然后需要設(shè)置WebApi 項(xiàng)目在生成項(xiàng)目時(shí)自動(dòng)生成描述API信息的XML文件，并需要將生成的XML配置文件SwaggerDemo.xml 設(shè)置為始終復(fù)制到輸出目錄：