在现在的开发中，前后端分离开发越来越明显，也越来越重要，但是后台开发人员在开发完接口之后给前端人员或者APP端调用，而前端人员或者APP端对接口的作用以及接口中的参数往往不懂，这样双方不得不多次沟通交流，很浪费时间。于是就需要一个中间的工具来无缝连接后台与前端。
这个中间工具就是今天的主角Swagger。
Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。Swagger 让部署管理和使用功能强大的API从未如此简单。
Swagger如何与SpringMvc集成？
集成步骤：
1.引入maven依赖，需要jackson的jar包支持
<!-- swagger --> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger2</artifactId> <version>2.4.0</version> </dependency> <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-swagger-ui</artifactId> <version>2.4.0</version> </dependency> <!-- jackson json --> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-core</artifactId> <version>2.2.3</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.2.3</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-annotations</artifactId> <version>2.2.3</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.module</groupId> <artifactId>jackson-module-jaxb-annotations</artifactId> <version>2.2.3</version> </dependency>
2.swagger配置类
package org.zjl.controller.swagger.config; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.ComponentScan; import org.springframework.context.annotation.Configuration; import org.springframework.web.servlet.config.annotation.EnableWebMvc; import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport; import springfox.documentation.builders.ApiInfoBuilder; import springfox.documentation.builders.PathSelectors; import springfox.documentation.builders.RequestHandlerSelectors; import springfox.documentation.service.ApiInfo; import springfox.documentation.service.Contact; import springfox.documentation.spi.DocumentationType; import springfox.documentation.spring.web.plugins.Docket; import springfox.documentation.swagger2.annotations.EnableSwagger2; /** * 描述：swagger2配置类 * @author zhengjinlei * @version 2017年4月19日 下午3:47:58 */ @EnableWebMvc @EnableSwagger2 @ComponentScan(basePackages={"org.zjl.controller.app"}) //需要扫描的包路径 @Configuration public class SwaggerApiConfig extends WebMvcConfigurationSupport{ @Bean public Docket createRestApi() { return new Docket(DocumentationType.SWAGGER_2) .apiInfo(apiInfo()) .select() .apis(RequestHandlerSelectors.basePackage("")) .paths(PathSelectors.any()) .build(); } private ApiInfo apiInfo() { return new ApiInfoBuilder() .title("Java从业者") .termsOfServiceUrl("") .contact(new Contact("我本码农", "", "15851503917@163.com")) .version("v1.0") .build(); } } spring的配置文件中声明Validator
<!-- 配置 JSR303 Bean Validator 定义 --> <bean id="validator" class="org.springframework.validation.beanvalidation.LocalValidatorFactoryBean" /> 3.此时启动工程，会扫描包中的controller类生成没有任何说明的API文档
4.如果想要带有说明的在线API文档，需要在扫描的类中配置一些注解
例如：
package org.zjl.controller.app; import java.util.ArrayList; import java.util.Collections; import java.util.HashMap; import java.util.List; import java.util.Map; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestMethod; import org.springframework.web.bind.annotation.RestController; import org.zjl.entity.User; import io.swagger.annotations.Api; import io.swagger.annotations.ApiImplicitParam; import io.swagger.annotations.ApiImplicitParams; import io.swagger.annotations.ApiOperation; /** * 描述：用户controller * @author zhengjinlei * @version 2017年4月19日 下午4:01:49 */ @Api(value="users") @RestController @RequestMapping(value = "/users") // 通过这里配置使下面的映射都在/users下，可去除 public class UserController { static Map<Long, User> users = Collections.synchronizedMap(new HashMap<Long, User>()); @ApiOperation(value = "获取用户列表", notes = "") @RequestMapping(value = { "" }, method = RequestMethod.GET) public List<User> getUserList() { List<User> r = new ArrayList<User>(users.values()); return r; } @ApiOperation(value = "创建用户", notes = "根据User对象创建用户") @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User") @RequestMapping(value = "", method = RequestMethod.POST) public String postUser(@RequestBody User user) { //users.put(user.getId(), user); return "success"; } @ApiOperation(value = "获取用户详细信息", notes = "根据url的id来获取用户详细信息") @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long") @RequestMapping(value = "/{id}", method = RequestMethod.GET) public User getUser(@PathVariable Long id) { return users.get(id); } @ApiOperation(value = "更新用户详细信息", notes = "根据url的id来指定更新对象，并根据传过来的user信息来更新用户详细信息") @ApiImplicitParams({ @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long"), @ApiImplicitParam(name = "user", value = "用户详细实体user", required = true, dataType = "User") }) @RequestMapping(value = "/{id}", method = RequestMethod.PUT) public String putUser(@PathVariable Long id, @RequestBody User user) { User u = users.get(id); u.setName(user.getName()); //u.setAge(user.getAge()); users.put(id, u); return "success"; } @ApiOperation(value = "删除用户", notes = "根据url的id来指定删除对象") @ApiImplicitParam(name = "id", value = "用户ID", required = true, dataType = "Long") @RequestMapping(value = "/{id}", method = RequestMethod.DELETE) public String deleteUser(@PathVariable Long id) { users.remove(id); return "success"; } } 注解说明：
@ApiIgnore 忽略注解标注的类或者方法，不添加到API文档中 @ApiOperation 展示每个API基本信息 value api名称 notes 备注说明 @ApiImplicitParam 用于规定接收参数类型、名称、是否必须等信息 name 对应方法中接收参数名称 value 备注说明 required 是否必须 boolean paramType 参数类型 body、path、query、header、form中的一种 body 使用@RequestBody接收数据 POST有效 path 在url中配置{}的参数 query 普通查询参数 例如 ?query=q ,jquery ajax中data设置的值也可以，例如 {query:”q”},springMVC中不需要添加注解接收 header 使用@RequestHeader接收数据 form 笔者未使用，请查看官方API文档 dataType 数据类型，如果类型名称相同，请指定全路径，例如 dataType = “java.util.Date”，springfox会自动根据类型生成模型 @ApiImplicitParams 包含多个@ApiImplicitParam @ApiModelProperty 对模型中属性添加说明，只能使用在类中。 value 参数名称 required 是否必须 boolean hidden 是否隐藏 boolean 其他信息和上面同名属性作用相同，hidden属性对于集合不能隐藏，目前不知道原因 @ApiParam 对单独某个参数进行说明，使用在类中或者controller方法中都可以。注解中的属性和上面列出的同名属性作用相同到此，一个完美的结合在线API文档的工程的完成了，启动工程，在浏览器中输入 http: //IP:port/工程名/swagger-ui.html
就可以浏览属于你工程的在线API文档。
