SpringBoot项目中Swagger的配置和使用

一、概述
Swagger是一个规范、完整的框架，用于生成、描述、调用和可视化Restful风格的Web服务。使用Swagger可以使前端和后端人员实时的进行接口查看和协调。也可对相关的接口进行测试。

步骤：
1 添加swagger的pom.xml依赖

  <!-- swagger -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>

2 新建Swagger配置类：SwaggerConfig

@Configuration
@EnableSwagger2  //开启Swagger
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .pathMapping("/")
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.yh.development.controller"))
                .paths(PathSelectors.any())
                .build().apiInfo(new ApiInfoBuilder()
                        .title("development")
                        .description("")
                        .version("1.0")
                        .build());
    }
    
    /*配置多个分组，只需要配置多个Docket即可，设置不同分组扫描不同的包*/
    @Bean
    public Docket docketA() {
        return new Docket(DocumentationType.SWAGGER_2).groupName("A");
    }

3 新建用户操作控制器：SysUserController

@Api(tags = "用户操作模块API")//作用在模块API类上，对API模块进行说明
@RestController(value = "/sys/user/")
public class SysUserController {
    @ApiOperation("添加用户接口")//作用在API方法上，对操作进行说明
    @PostMapping(value = "/add")
    public String add(User user) {
        return "success";
    }

4 启动项目 访问： http://localhost:8089/swagger-ui.html 就可以了！