官档地址:
https://docs.microsoft.com/zh-cn/aspnet/core/tutorials/getting-started-with-swashbuckle
个人整理:
1、开启注释:属性-生成-所有配置-XML文档文件-"document.xml"
2、Nuget安装 Swashbuckle.AspNetCore 和 Newtonsoft.Json
3、Startup.ConfigureServices中添加
//2.2之后版本,swagger支持文件上传UI
services.AddMvc().SetCompatibilityVersion(CompatibilityVersion.Latest)
//保留json大小写状态
.AddJsonOptions(options => options.SerializerSettings.ContractResolver = new Newtonsoft.Json.Serialization.DefaultContractResolver());
//生成swagger
services.AddSwaggerGen(options =>
{
//设置swagger标题
options.SwaggerDoc("doc", new Swashbuckle.AspNetCore.Swagger.Info() { Title = "Edit Titile Here" });
//添加接口注释
options.IncludeXmlComments("document.xml");
});
4、Startup.Configure中添加
app.UseSwagger();
app.UseSwaggerUI(options => options.SwaggerEndpoint("/swagger/doc/swagger.json", null));
5、访问地址:/swagger 区分大小写