asp .net core Api Swagger集成配置項目

1，創建  asp .net core 3.1 Api  Swagger項目

2，添加程序包，通過命令的方式進行添加如下：

      在 工具->NuGet 包管理器->程序包管理器控制檯 進行單擊進去，能後在再控制檯中輸入命令

執行以下命令

Install-Package Swashbuckle.AspNetCore -Version 5.0.0-rc4

3，添加 並配置Swagger中間件

    3.1 在startup類中的ConfigureServices 方法中的服務集合中添加如下代碼

  services.AddSwaggerGen(c =>
  {
      c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });
  });

 3.2  在startup類中的Configure 方法中啓用中間件爲生成的 JSON 文檔和 Swagger UI 提供服務

 app.UseSwagger();
  app.UseSwaggerUI(c =>
  {
      c.SwaggerEndpoint("/swagger/v1/swagger.json", "My API V1");
  });

4，如果對接口做了xml註釋，要在Startup添加如下代碼,纔可以顯示出來

     先引入NuGet包:Microsoft.Extensions.PlatformAbstractions

     然後右鍵屬性

 

     再在Startup中添加下面的代碼

  services.AddSwaggerGen(c =>
            {
                c.SwaggerDoc("v1", new OpenApiInfo { Title = "My API", Version = "v1" });

                var xmlFile = $"{Assembly.GetExecutingAssembly().GetName().Name}.xml";
                var xmlPath = Path.Combine(AppContext.BaseDirectory, xmlFile);
                c.IncludeXmlComments(xmlPath, true); //添加控制器層註釋（true表示顯示控制器註釋）

            });

項目需要配置一下勾上xml複選框要不能會報錯：

右邊單擊 項目->選擇屬性->再選擇生成->勾選xml複選框

5，在launchSettings.json中更改一下launchUrl這個環境變量，這樣就不用每次都改地址欄了