swagger简介
别名&＃xff1a;丝袜哥
功能&＃xff1a;用于生产api文档
swagger安装
Nuget搜索swagger&＃xff0c;然后安装Swashbuckle
swagger使用
生成api的xml文档
webapi项目右键——属性——生产——输出
汉化Swagger
新建一个js&＃xff0c;目录/Scripts/Swagger/swagger_lang.js&＃xff0c;属性设置为[嵌入的资源]
设置Swagger
修改/App_Start/SwaggerConfig.cs&＃xff0c;注意xml地
using System.Web.Http;
using WebActivatorEx;
using cms.WebApi;
using Swashbuckle.Application;[assembly: PreApplicationStartMethod(typeof(SwaggerConfig), "Register")]namespace cms.WebApi
{public class SwaggerConfig{public static void Register(){var thisAssembly &＃61; typeof(SwaggerConfig).Assembly;GlobalConfiguration.Configuration.EnableSwagger(c &＃61;>{c.SingleApiVersion("v1", "cms.WebApi");c.IncludeXmlComments(string.Format("{0}/App_Data/cms.WebApi.XML", System.AppDomain.CurrentDomain.BaseDirectory));//设置xml地址}).EnableSwaggerUi(c &＃61;>{c.DocumentTitle("My webapi");c.InjectJavascript(thisAssembly, "cms.WebApi.Scripts.Swagger.swagger_lang.js");//汉化js});}}
}
控制器
// GET api/values///
运行测试
访问地址&＃xff1a;http://localhost:30022/swagger/
注意&＃xff1a;刚开始我的webapi和mvc在一个项目中&＃xff0c;导致汉化失败&＃xff0c;汉化js路径找不到。然后把webapi单独一个项目后正常了&＃xff0c;坑啊&＃xff01;&＃xff01;&＃xff01;
end
京公网安备 11010802041100号