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 = "ruxingxing@xakcdz.com" }
});
});
#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)运行效果