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

title: ASP.NET Web API集成Swagger（1）-安装与简单配置
date: 2019-03-01 00:00:00
categories:

• 后端
  tags:
• ASP.NET
• WebAPI
• RESTful

建立Web API项目

1. 新建项目—>ASP.NET MVC4项目—>WebAPI

2. 

   NuGet中搜索安装 Swashbuckle

3. 打开NuGet管理控制台命令安装Swashbuckle
   install-package Swashbuckle

4. 
   

配置项目属性

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

测试配置是否成功

1. 运行调试项目
2. 访问项目路径:http://localhost:18247/swagger
3.