Swagger2及Springboot项目整合Swagger：

1、Swagger介绍

1.1、Swagger是什么?

Swagger是一个规范且完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。

1.2、Swagger有什么用?

Swagger的目标是对 REST API 定义一个标准且和语言无关的接口，可以让人和计算机拥有无须访问源码、文档或网络流量监测就可以发现和理解服务的能力。当通过 Swagger 进行正确定义，用户可以理解远程服务并使用最少实现逻辑与远程服务进行交互。与为底层编程所实现的接口类似，Swagger 消除了调用服务时可能会有的猜测。

1.3、Swagger的优势是什么?

Swagger的优势：    1.3.1、支持API自动生成同步的在线文档：使用 Swagger 后可以直接通过代码生成文档，不再需要自己手动编写接口文档了，对程序员来说非常方便，可以节约写文档的时间去学习新技术。    1.3.2、提供Web页面在线测试 API：光有文档还不够，Swagger 生成的文档还支持在线测试。参数和格式都定好了，直接在界面上输入参数对应的值即可在线测试接口。

2、Springboot项目整合Swagger

2.0、总体分为五步：

    1.分别是pom文件导入依赖;    2.创建Swagger配置类，进行基本配置和注入bean;    3.编写测试类：在Controller层，使用注解进行集成;    4.启动项目，登录地址进行查看文档;    5.进行接口调用验证。

2.1、首先进行pom文件导包

                io.springfox        springfox-swagger2        ${springfox-swagger2.version}                io.springfox        springfox-swagger-ui        ${springfox-swagger2.version}            2.9.2        注意：Springboot版本和Swagger版本兼容问题，如：Springboot版本是2.3.1，Swagger版本是2.9.2。

2.2、其次创建配置类

    @Configuration//配置类告诉springboot启动的时候加载这个类    @EnableSwagger2//启用Swagger2    public class SwaggerConfig {        @Bean        public Docket createRestApi() {            return new Docket(DocumentationType.SWAGGER_2)                    .apiInfo(apiInfo())                    .select()                    .apis(RequestHandlerSelectors.basePackage("com.example.mallsix.controller"))// 指定扫描包下面的注解，一般都是扫描Controller、DTO、POJO等                    .paths(PathSelectors.any())                    .build();        }            // 创建api的基本信息        private ApiInfo apiInfo() {            return new ApiInfoBuilder()                    .title("YaNan StudyTest APIs")//指定名称                    .description("学习Springboot集成Swagger2构建RESTful APIs")//对名称进行描述                    .termsOfServiceUrl("https://www.termsofservice.com")//设置Terms of service地址                    .contact("zhangsan")                    .version("1.0.0")                    .build();        }    }

2.3、编写Swagger测试类

    @Api("Swagger测试接口")    @RestController    @RequestMapping("/swagger")    public class SwaggerTestController {            @ApiOperation(value="获取用户信息", notes="根据id来获取用户详细信息")//方法名说明        @ApiImplicitParam(name="id", value="用户ID", required=true, dataType="String")//方法参数说明        @RequestMapping(value="/{id}", method= RequestMethod.GET)//设置方法映射路径和方法类型(使用RESTful风格)        public Map getInfo(@PathVariable String id) {            Map map = new HashMap();            map.put("id", id);            map.put("name", "yangStudy");            map.put("age", "23");            return map;        }        }        注意：要写在配置类里面指定的扫描包下面，不然不扫描就尴尬了。

2.4、启动项目登录地址查看文档

    项目启动成功后，直接访问项目路径+swagger-ui.html    项目路径看你配置文件application.yml或者application.properties里面端口和配置路径    2.4.1、application.yml文件配置如下：            server:              port: 8085              servlet:                context-path: /yyn        访问路径就是:http://localhost:8085/yyn/swagger-ui.html    2.4.2、application.properties文件配置如下：            service.port=8084            server.servlet.context-path=/yn        访问路径就是:http://localhost:8084/yn/swagger-ui.html            注意：springboot2.0版本以后是server.servlet.context-path，2.0版本以下是server.context-path

2.5、编写Swagger测试类

  按下图的步骤1、2执行即可：

 按下图的步骤3、4执行即可：  

  按下图的步骤5、6执行，查看步骤7所标的框即可。

  感觉比Postman好用