WebApi生成文档

本文包括两个部分:web

  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);
      }api

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

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

相关文章
相关标签/搜索