Swagger生成WebApi帮助文档

397 阅读1分钟

Swagger 是一个规范和完整的框架,用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。是非常流行用于编辑api给前端同事用、或者测试api的工具。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法,参数和模型紧密集成到服务器端的代码,允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。 今天在搭建WebApi时,将Swagger引入,来生成及管理WebApi文档。具体的操作步骤如下: 1、新建空白WebApi项目,使用Nuget包管理器安装,打开Nuget包管理器,搜索“Swagger”,安装两个资源:Swashbuckle、Swagger.Net.UI 2、选中项目,右键属性->生成->输出->勾选“XML文档文件(x)”,并将值设为“App_Data\WebApiHelper.xml”;您可以根据自己的项目设置具体的路径及保存文件名。 3、找到SwaggerConfig文件的注册方法,去掉注释的这一句代码:(“c.IncludeXmlComments(GetXmlCommentsPath());”),用于在UI上加载生成的xml文档。GetXmlCommentsPath方法的实现如下:读取注释文件的路径

private static string GetXmlCommentsPath()
{
  return string.Format("{0}/App_Data/WebApiHelper.XML", System.AppDomain.CurrentDomain.BaseDirectory);
}

4、找到SwaggerNet文件,将文件中的这两句注释掉

//[assembly: WebActivator.PreApplicationStartMethod(typeof(WebApiHelper.App_Start.SwaggerNet), "PreStart")]
//[assembly: WebActivator.PostApplicationStartMethod(typeof(WebApiHelper.App_Start.SwaggerNet), "PostStart")]

5、运行,引入成功