ASP.NET Web API集成Swagger（1）-安装与简单配置

淡淡的烟草味﹌ 2022-12-22 09:57 88阅读 0赞

## 建立Web API项目 ##

1.  新建项目–>ASP.NET MVC4项目–>WebAPI
2.  [![d6de476945a5878c653e16cb8388ddb3.png][]][d6de476945a5878c653e16cb8388ddb3.png 1]

## NuGet中搜索安装 Swashbuckle ##

1.  打开NuGet管理控制台命令安装Swashbuckle  
    `install-package Swashbuckle`
2.  [![96696f675fc73091f32de9c0798753b0.png][]][96696f675fc73091f32de9c0798753b0.png 1]  
    [![208a9d881f2b4e347e96374d95854586.png][]][208a9d881f2b4e347e96374d95854586.png 1]

## 配置项目属性 ##

1.  直接从NuGet中安装Swashbuckle，而且并不想做更多的定制，那么UI界面就不用做更多的处理，所有的资源Resources都是嵌入到Swashbuckle.DLL中的（其中还包括css/js/images等静态文件），可以在VS的对象资源管理器中看到  
    [![354fe4865ab7ce4ce6b2714dfbd7d6ae.png][]][354fe4865ab7ce4ce6b2714dfbd7d6ae.png 1]
2.  安装完成之后App\_Start中会多一个SwaggerConfig这样一个配置文件，这个文件是Swagger为我们留下的配置入口，我们可以根据其中的注释和介绍做很多事情。把Swagger单独出来一个文件夹，直接将配置类拖进去，整理一下，如下效果：  
    [![d512eb5abd7c0049436b041fccd968de.png][]][d512eb5abd7c0049436b041fccd968de.png 1]
3.  配置项目属性：  
    选择项目–>属性–>生成选项卡：按照如下图中将输出项中XML文档文件项勾选，保存。  
    [![4c6b60f2fafed9c5674c2c826b2a81c5.png][]][4c6b60f2fafed9c5674c2c826b2a81c5.png 1]
4.  配置文件SwaggerConfig.cs中主要有两个入口：EnableSagger和EnableSwaggerUi,顾名思义，配置其后台项和前台项。
5.  找到配置文件中的IncludeXmlComments方法，配置读取XML的路径：[![2b6319907f1a8c85e6e7bc418f425aeb.png][]][2b6319907f1a8c85e6e7bc418f425aeb.png 1]  
    `c.IncludeXmlComments(string.Format("{0}/bin/SwaggerDemo.XML", System.AppDomain.CurrentDomain.BaseDirectory));`

## 测试配置是否成功 ##

1.  运行调试项目
2.  访问项目路径:`http://localhost:18247/swagger`
3.  [![5d564607e13c09eef0d1e3e11d32b8d7.png][]][5d564607e13c09eef0d1e3e11d32b8d7.png 1]

[d6de476945a5878c653e16cb8388ddb3.png]: /images/20221120/3ede885614e14153a751fb837228b6e1.png
[d6de476945a5878c653e16cb8388ddb3.png 1]: https://images.fengjiaheng.top/images/20180405/01.png
[96696f675fc73091f32de9c0798753b0.png]: https://img-blog.csdnimg.cn/img_convert/96696f675fc73091f32de9c0798753b0.png
[96696f675fc73091f32de9c0798753b0.png 1]: https://images.fengjiaheng.top/images/20180405/02.png
[208a9d881f2b4e347e96374d95854586.png]: https://img-blog.csdnimg.cn/img_convert/208a9d881f2b4e347e96374d95854586.png
[208a9d881f2b4e347e96374d95854586.png 1]: https://images.fengjiaheng.top/images/20180405/03.png
[354fe4865ab7ce4ce6b2714dfbd7d6ae.png]: https://img-blog.csdnimg.cn/img_convert/354fe4865ab7ce4ce6b2714dfbd7d6ae.png
[354fe4865ab7ce4ce6b2714dfbd7d6ae.png 1]: https://images.fengjiaheng.top/images/20180405/04.png
[d512eb5abd7c0049436b041fccd968de.png]: https://img-blog.csdnimg.cn/img_convert/d512eb5abd7c0049436b041fccd968de.png
[d512eb5abd7c0049436b041fccd968de.png 1]: https://images.fengjiaheng.top/images/20180405/05.png
[4c6b60f2fafed9c5674c2c826b2a81c5.png]: https://img-blog.csdnimg.cn/img_convert/4c6b60f2fafed9c5674c2c826b2a81c5.png
[4c6b60f2fafed9c5674c2c826b2a81c5.png 1]: https://images.fengjiaheng.top/images/20180405/06.png
[2b6319907f1a8c85e6e7bc418f425aeb.png]: https://img-blog.csdnimg.cn/img_convert/2b6319907f1a8c85e6e7bc418f425aeb.png
[2b6319907f1a8c85e6e7bc418f425aeb.png 1]: https://images.fengjiaheng.top/images/20180405/07.png
[5d564607e13c09eef0d1e3e11d32b8d7.png]: https://img-blog.csdnimg.cn/img_convert/5d564607e13c09eef0d1e3e11d32b8d7.png
[5d564607e13c09eef0d1e3e11d32b8d7.png 1]: https://images.fengjiaheng.top/images/20180405/08.png