【开发笔记系列（二）】配置Swagger Api接口文档

首先导入三个包

• Swashbuckle.AspNetCore.Swagger;
• Swashbuckle.AspNetCore.SwaggerGen;
• Swashbuckle.AspNetCore.SwaggerUI;

接着在Startup中设置配置信息，注册服务。
在ConfigureServices(IServiceCollection services)函数中加入：

设置配置信息

if (Configuration.GetSection("UseSwagger").Value == "true") //开发环境下启动swaggeApi文档页面
{
	services.AddSwaggerGen(option =>
	{
		option.SwaggerDoc("LockApi", new OpenApiInfo
		{
			Version = "v1.0.0", //版本号
			Title = "LockApi", //标题
			Description = "LockApi",  //描述
			Contact = new OpenApiContact() { Name = "Yan-X", Email = "519945812@qq.com" } //文档联系方式
		});

		// include document file
		var docsrc = Path.Combine(AppContext.BaseDirectory, $"{typeof(Startup).Assembly.GetName().Name}.xml");
		option.IncludeXmlComments(docsrc, true);
		});
}

在管道中注册服务：

if (Configuration.GetSection("UseSwagger").Value == "true")
{
	app.UseSwagger();
	app.UseSwaggerUI(option =>
	{
		option.SwaggerEndpoint("/swagger/LockApi/swagger.json", "LockApi Docs");
		option.RoutePrefix = string.Empty;
		option.DocumentTitle = "LockApi";
	});
}

再到项目里

右键属性-->生成-->输出

勾选生成XML文档文件，再启动项目会在解决方案里面生成一个XXX.xml的文档文件，设置为始终复制，到这一步。整个项目中会有xml校验注释解析。

然后到"错误和警告"

输入：;1591代码即可解决校验注释解析

到此是Swagger的基础配置使用方法。swagger里面还集成了多租户，单点登录，校验token等等方法有时间再去探究