.net core 中Swagger生成接口文档的简单使用

1.首先下载安装"Swashbuckle.AspNetCore"NUget包，可以通过管理NUget中直接搜索下载，也可以通程序包管理控制台执行“Install-Package Swashbuckle.AspNetCore”命令下载安装

2.安装完成后，将 Swagger 生成器添加到 Startup.ConfigureServices 方法中的服务集合中
//注册Swagger生成器，定义一个和多个Swagger 文档

services.AddSwaggerGen(c =>
{
c.SwaggerDoc("v1", new Info { Title = "第一个API文档", Version = "v1" });
// 为 Swagger JSON and UI设置xml文档注释路径
var basePath = Path.GetDirectoryName(typeof(Program).Assembly.Location);//获取应用程序所在目录（绝对，不受工作目录影响，建议采用此方法获取路径）
var xmlPath = Path.Combine(basePath, "SwaggerDemo.xml");
c.IncludeXmlComments(xmlPath);
});

 

3.在 Startup.Configure 方法中，启用中间件为生成的 JSON 文档和 Swagger UI 提供服务：

//启用中间件服务生成Swagger作为JSON终结点
app.UseSwagger();
//启用中间件服务对swagger-ui，指定Swagger JSON终结点
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1/swagger.json", "第一个API文档");
});

 

4.启用XML 注释
(1)：右键单击“解决方案资源管理器”中的项目，然后选择“属性”
(2)：查看“生成”选项卡的“输出”部分下的“XML 文档文件”框

5.启用 XML 注释后会为未记录的公共类型和成员提供调试信息。如果出现很多警告信息 例如，以下消息指示违反警告代码 1591：
warning CS1591: Missing XML comment for publicly visible type or member 'TodoController.GetAll()'
如果你有强迫症，想取消警告怎么办呢？在禁止警告加上“1591”即可

 

其他高级用法可以自行百度或者看文档