ASP.NET CORE 3.1 WebApi 引用Swagger

ASP.NET CORE 3.1 WebApi 引用Swagger

1、依賴項-管理NuGet程序包-瀏覽搜索“Swashbuckle.AspNetCore”安裝。
2、Startup.cs文件中ConfigureServices方法配置服務

#region Swagger
services.AddSwaggerGen(c =>
 {
     c.SwaggerDoc("v1", new OpenApiInfo
     {
         Version = "v0.1.0",
         Title = "RUXING API",
         Description = "框架說明文檔",
         Contact = new OpenApiContact { Name = "RUXING", Email = "[email protected]" }
     });
 });
 #endregion

3、Startup.cs文件中Configure方法啓動Http中間件

#region Swagger
app.UseSwagger();
app.UseSwaggerUI(c =>
{
    c.SwaggerEndpoint("/swagger/v1/swagger.json", "ApiHelp V1");
});
#endregion

4、運行效果
F5 運行調試，在域名後面輸入/swagger，http://localhost:54067/swagger/index.html 點擊回車

5、設置swagger頁面爲首頁——開發環境
打開文件launchSettings.json 修改launchUrl即可。

6、api接口方法添加註釋
（1）在需要的api接口方法上，連點三次 / 即可

（2）右鍵web 項目名稱=>屬性=>生成，勾選“輸出”下面的“xml文檔文件”

（3）Startup.cs文件中ConfigureServices方法導入文件

var basePath = AppContext.BaseDirectory;
var xmlPath = Path.Combine(basePath, "ruxing0515.xml");
c.IncludeXmlComments(xmlPath,true);

（4）運行效果

7、控制器添加註釋
（1）在控制器上連點三次 / 即可

（2）配置swagger的 xml 文檔導入方法

（3）運行效果