WebApi生成文档

本文包括两个部分：

1. webapi中使用swagger
2. 修改webapi的路由和默认参数

• WebApi中使用swagger
• 

• 项目打开之后，选择 引用，右键，管理NuGet程序包

• 浏览，搜索swagger，选择第一个swashbuckle，安装

• 

• 安装好之后，右键项目，选择属性，生成，在下面的输出那里勾选：XML文档文件，如果没有自动填充好路径，需要自己填写一下，文件名可以自己

• 

• 打开App_Start文件夹下的SwaggerConfig.cs文件，新增一个如下方法：

• private static string GetXmlCommentsPath()
  {
  return System.String.Format(@"{0}\bin\Coldairarrow.WebApi.xml", System.AppDomain.CurrentDomain.BaseDirectory);
  }

• 搜索GetXmlCommentsPath，下面能搜到已经注释了，自己把注释放开，要是没搜到，就自己手动写一下c.IncludeXmlComments(GetXmlCommentsPath());注意要写在register方法里面

• 

• 运行项目，在根路径后面直接加swagger，就会自动跳转到文档，如：http://localhost:13520/swagger/ui/index，能看到我们写的一些注释

• 

原文链接:https://www.cnblogs.com/arthuryao/p/11124378.html
如有疑问请与原作者联系

标签：

版权申明：本站文章部分自网络，如有侵权，请联系：west999com@outlook.com
特别注意：本站所有转载文章言论不代表本站观点，本站所提供的摄影照片，插画，设计作品，如需使用，请与原作者联系，版权归原作者所有