以前在做WebAPI挪用测试时,一直在使用Fiddler测试工具了,而且这个用起来对照繁琐,需要各类配置,,并且不直不雅观,还有一点是还得弄大白URL地点和要通报的参数,然后才华挪用。 比来新入职,公司里面也用到了WebAPI挪用,但是使用的挪用工具让我眼前一亮,他用的是Swagger。这个工具可能有的人没风闻过,它仅仅引用一个包即可嵌入到项目中,用的时候直接输入网址就能看到挪用界面了。你是不是之前也没用过呢,是的话,那请看下面介绍吧~
1. 首先,创建webpapi类型的项目 TestSwagger
2.使用 Nuget 安置Swashbuckle.core包
安置完成后,即可看到这些类与文件都是安置完成时swagger添加的。
3. 打开xml文档文件
右键项目属性—>生成—>勾选XML文档文件
4.添加注释
我们发明,安置完成后,写注释并没有在swagger页面上面增加,所以我们此刻开启注释
在SwaggerConfig类中,EnableSwagger的时候添加下面XML解析
using System.Web.Http; using WebActivatorEx; using TestSwagger; using Swashbuckle.Application; [assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")] namespace TestSwagger { public class SwaggerConfig { public static void Register() { var thisAssembly = typeof(SwaggerConfig).Assembly; GlobalConfiguration.Configuration .EnableSwagger(c => { c.SingleApiVersion("v1", "TestSwagger"); //添加XML解析 c.IncludeXmlComments(GetXmlCommentsPath()); }) .EnableSwaggerUi(c => { }); } //添加XML解析 private static string GetXmlCommentsPath() { return string.Format("{0}/bin/TestSwagger.XML", System.AppDomain.CurrentDomain.BaseDirectory); } } }
注意改削相应的XML名字。