传奇网站架设方法,oppo手机开发者选项在哪,外贸网络推广网,品牌商标购买网站一. WebApi自带生成api文档
1. 说明 通过观察#xff0c;发现WebApi项目中Area文件夹下有一个HelpPage文件夹#xff0c;如下图#xff0c;该文件夹就是WebApi自带的生成Api的方式#xff0c;如果该文件夹没了#xff0c;可以通过Nuget安装#xff1a;Microsoft.AspNet.…一. WebApi自带生成api文档
1. 说明 通过观察发现WebApi项目中Area文件夹下有一个HelpPage文件夹如下图该文件夹就是WebApi自带的生成Api的方式如果该文件夹没了可以通过Nuget安装Microsoft.AspNet.WebApi.HelpPage 你就会发现下图这一坨代码又回来了。 使用http://localhost:2131/Help/Index , 即可访问生成的Api目录如下图 缺点你会发现一个很坑爹的问题方法名的注释和参数的注释均不显示这对使用者而言相当不放方便了。
2. 改进支持参数的注释 (1). 选中项目右键属性填写生成xml文件的路径如下图 bin\api.xml (2). 找到 Areas/HelpPage/App_Start 目录下的HelpPageConfig.cs 文件Register 方法添加一行代码 config.SetDocumentationProvider(new XmlDocumentationProvider(AppDomain.CurrentDomain.BaseDirectory bin\\api.xml)); (3). 大功告成再次访问 http://localhost:2131/Help/Index 发现无论是方法名还是参数名均有描述了 3. 小结 上述通过改进已经生成比较完善的Api文档了但美中不足的是不能直接测试当然可以整合别的控件使其支持但比较麻烦不如使用下面的SwashBuckle生成SwaggerUI形式的Api文档。 二. 借助SwaggerUI生成api文档 1. 通过Nuget安装 Swashbuckle 版本5.6.0程序集会发现在 App_Start 文件夹下生成一个 SwaggerConfig.cs 配置文件用于配置 SwaggerUI 相关展示行为的如下图 (2). 选中项目右键属性勾上xml文档文件注意这里默认是什么就保留什么不要在自己改了 。如下图 bin\05-WebApiExtend.xml (3). 在SwaggerConfig.cs文件中 搜索 【 c.IncludeXmlComments(GetXmlCommentsPath()); 】在这句话的下面新增一句代码 c.IncludeXmlComments(AppDomain.CurrentDomain.BaseDirectory bin\\05-WebApiExtend.xml); (4). 大功告成访问http://localhost:2182/swagger/ui/index 即可查看生成Api文档。
