1、首先引用nuget包:Swashbuckle.AspNetCore
我使用的是.net core 3.0的,需要引用的的nuget包是5.0预览版的
添加中间件
services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new OpenApiInfo
{
Title = "Curry API",
Description = "API for Curry",
Version = "v1",
Contact = new OpenApiContact() { Name = "Curry", Email = "85232564@qq.com" }
});
var xmlPath = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, "Api.xml");
c.IncludeXmlComments(xmlPath);
});
使用
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "Curry V1");
});
为输出xml配置路径,以保证和我们使用的路径一致,这样才能显示出接口中的注释文字
当然我们在正式环境接口信息不宜暴露,可以通过环境变量来控制
随便写两个接口测试下,运行