依赖项——右键——管理NuGet程序包——浏览——输入以下内容
Install-Package Swashbuckle.AspNetCore -Pre
双击Properties——点击生成——勾选XML文档文件
双击Startup.cs——在ConfigureServices、Configure中添加以下内容:
ConfigureServices:
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new Info
{
Version = "v1",
Title = "接口文档",
Description = "接口文档",
TermsOfService = "None",
Contact = new Contact { Name = "唐少", Email = "tang14455@163.com", Url = "" }
});
//设置swagger json和ui的注释路径。
var basePath = PlatformServices.Default.Application.ApplicationBasePath;
var xmlPath = Path.Combine(basePath, "WebApi_Core.xml");//同XML文档文件中名称相同
c.IncludeXmlComments(xmlPath);
// c.OperationFilter<HttpHeaderOperation>(); // 添加httpHeader参数
});
Configure:
// 使中间件能够将生成的Swagger作为JSON端点。
app.UseSwagger();
// 使中间件能够服务swagger-ui(HTML,JS,CSS等),指定Swagger JSON端点。
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "TwBusManagement API V1");
c.ShowExtensions();
});
双击Properties下launchSettings.json——更改launchUrl中值为swagger(默认打开Swagger帮助页):
运行测试