关于为什么用Swagger
目前稍微有点规模的公司，已经从原先的瀑布流开发到了敏捷开发，，实现前后端疏散，为从此端工程师只存眷写好Api即可，那措施员最讨厌的就是写Api文档了，故而孕育产生了Swagger。
Swagger道理
Swagger就是操作反射技术遍历所有Api接口，并且从xml文件中读取注释，在操作Swagger内置的模板组合html显示至客户端实现接口可视化，并且可挪用。
Asp.net WebApi Swagger集成
1：vs2017，新建web项目，选择WebApi
2：删除Views、Scripts、Models、fonts、Content、Areas目录
3：删除RouteConfig.cs、FilterConfig.cs、BundleConfig.cs
4：删除HomeController.cs
5：Global.asax中删除异常代码
6：nuget搜索Swagger,安置 Swashbuckle,Swagger.Net.UI
7：右键项目——》属性——》生成——》输出——》勾选XML文档文件——》生存
8：改削SwaggerConfig.cs
新增要领，释放c.IncludeXmlComments(GetXmlCommentsPath());的注释（注意：例如返回值为东西，然后又不在同一个项目，则需要多次挪用）
private static string GetXmlCommentsPath() { eturn System.String.Format(@"{0}\bin\{项目名称}.XML", System.AppDomain.CurrentDomain.BaseDirectory); }
9：右键项目NuGet——》已安置——》搜索Swagger，卸载Swagger.Net.UI——》选项勾选强制卸载，点击卸载。卸载Swagger.Net
10：然后在url地点中:例如：:port/swagger即可
Swagger进阶
1：当有dto项目时，此时dto也需要把注释打到客户端，注意dto项目也参考上面第7点生成xml文件，复制第8点的要领
2：Swagger新增Header信息，在上方注释的处所插手：c.OperationFilter<HttpHeaderFilter>(); 拷贝下方代码
public class HttpHeaderFilter : IOperationFilter { public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription) { if (operation.parameters == null) operation.parameters = new List<Parameter>(); var filterPipeline = apiDescription.ActionDescriptor.GetFilterPipeline(); //判断是否添加权限过滤器 var isAuthorized = filterPipeline.Select(filterInfo => filterInfo.Instance) .Any(filter => filter is ErpFilterAttribute); //判断是否允许匿名要领 //var allowAnonymous = apiDescription.ActionDescriptor.GetCustomAttributes<AllowAnonymousAttribute>().Any(); if (isAuthorized) { operation.parameters.Add(new Parameter { name = "AppId", @in = "header", description = "应用ID（机构编号）", required = false, type = "string" }); operation.parameters.Add(new Parameter { name = "Version", @in = "header", description = "版本号", required = false, type = "string" }); operation.parameters.Add(new Parameter { name = "Ts", @in = "header", description = "时间戳", required = false, type = "string" }); operation.parameters.Add(new Parameter { name = "Lang", @in = "header", description = "语言包", required = false, type = "string" }); operation.parameters.Add(new Parameter { name = "Sign", @in = "header", description = "签名", required = false, type = "string" }); return; } } }
View Code3：注释的用法