SpingBoot 集成 Swagger2

1、pom.xml 添加 Maven 依赖

<!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.9.2</version>
    </dependency>
​
 <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
    <dependency>
       <groupId>io.springfox</groupId>
       <artifactId>springfox-swagger2</artifactId>
       <version>2.9.2</version>
    </dependency>

2、创建Swagger2配置类

package com.xxx.springboot.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class Swagger2 {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xxx.springboot.controller"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                .title("用户管理接口API文档") //设置文档的标题
                .version("1.0") // 设置文档的版本信息-> 1.0.0 Version information
                .build();
    }
}

3、API 接口编写

Swagger 通过注解定制接口对外展示的信息，这些信息包括接口名、请求方法、参数、返回信息等。更多注解类型：

• @Api：修饰整个类，描述Controller的作用
• @ApiOperation：描述一个类的一个方法，或者说一个接口
• @ApiParam：单个参数描述
• @ApiModel：用对象来接收参数
• @ApiProperty：用对象接收参数时，描述对象的一个字段
• @ApiResponse：HTTP响应其中1个描述
• @ApiResponses：HTTP响应整体描述
• @ApiIgnore：使用该注解忽略这个API
• @ApiError ：发生错误返回的信息
• @ApiImplicitParam：描述一个请求参数，可以配置参数的中文含义，还可以给参数设置默认值
• @ApiImplicitParams：描述由多个 @ApiImplicitParam 注解的参数组成的请求参数列表

作者：大鱼炖海棠
链接：https://www.jianshu.com/p/c79f6a14f6c9
来源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

@RestController
@Api(tags = "用户模块 UserController")
public class UserController {
    @Resource
    private UserService userService;

    @GetMapping("/user/{id}")
    @ApiOperation(value = "根据用户id查询用户对象")
    @ApiImplicitParam(name = "id",value = "用户id",required = true,paramType = "path")
    public User test(@PathVariable Integer id) {
        return userService.test(id);
    }

    @PostMapping("/user")
    @ApiOperation(value = "用户添加")
    @ApiImplicitParam(name = "user",value = "用户对象")
    public int insertUser(@RequestBody User user) {
        return userService.addUser(user);
    }
}

访问http://localhost:8080/swagger-ui.html 

 点击右上角的 “Try it out！”按钮，录入请求信息，点击 Execute 按钮完成一次请求调用！