SpringBoot集成Swagger2

添加依赖

在pom.xml文件中添加依赖

<!-- swagger2-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.9.2</version>
        </dependency>
        swagger2默认UI
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.9.2</version>
        </dependency>
        swagger2第三方UI
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>swagger-bootstrap-ui</artifactId>
            <version>1.9.6</version>
        </dependency>

编写配置文件

项目中添加配置文件swagger2.java

package com.jt.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.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

@Configuration
public class Swagger2 {


    //Swagger2核心配置 Docket
    @Bean
    public Docket createDocket(){
        return new Docket(DocumentationType.SWAGGER_2) //指定API类型为Swagger2
                .apiInfo(getApiInfo())                  //定义API文档汇总信息
                .select()
                .apis(RequestHandlerSelectors
                        .basePackage("com.jt.controller"))//指定要扫描的controller包
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo getApiInfo() {
        return new ApiInfoBuilder()
                .title("XX管理系统平台API")
                .contact(new Contact("Devin", "https://baidu.com", "devin.jt@jt.com"))
                .description("XX管理系统平台API")
                .licenseUrl("https://baidu.com")
                .version("1.0")
                .build();
    }
}

启动类中添加配置

在启动类中添加@EnableSwagger2

package com.jt;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.annotation.ComponentScan;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import tk.mybatis.spring.annotation.MapperScan;

@SpringBootApplication
@MapperScan( basePackages = "com.jt.mapper")
@ComponentScan(basePackages = {"com.jt","org.n3r.idworker"})
@EnableSwagger2
public class Application {
    public static void main(String[] args) {
        SpringApplication.run(Application.class,args);
    }
}

类中使用注解

@Api

注解在类上，描述当前类的作用

@Api(value = "帐号管理API",tags = "帐号管理API")
public class PassportController

@ApiOperation：

注解在方法上，描述方法作用

@ApiOperation(value = "用户名是否存在",notes = "用户名是否存在")
    @GetMapping("/usernameIsExist")
    public JsonResult usernameIsExist(@RequestParam String username)

@ApiParam：

描述参数(name:参数名，value:参数说明，require:是否必须)

public JsonResult usernameIsExist(@ApiParam(name = "username",value = "用户名",required = true)
                                          @RequestParam String username)

@ApiModel：

注解在参数对象上(value：对象名，description：描述)

@ApiModel(value ="UserBo",description = "用户参数对象")
public class UserBo

@ApiModelProperty：

描述参数对象的字段

• value:字段说明
• name:字段名
• dataType:字段类型
• required：是否必须
• example：举例
• hidden：隐藏

@ApiModel(value ="UserBo",description = "用户参数对象")
public class UserBo {

    @ApiModelProperty(value = "用户名",dataType ="String",required = true)
    private String username;

    @ApiModelProperty(value = "密码",name = "password",dataType ="String",required = true)
    private String password;

    @ApiModelProperty(value = "确认密码",name = "confirmPassword",dataType ="String",required = true)
    private String confirmPassword;
}

@ApiImplicitParam

用于注解单个方法参数，如果有多个参数，用@ApiImpliciParams包裹@ApiImpliciParam

• value:参数说明
• name:参数名
• dataType:字段类型
• required：是否必须
• example：举例

 @ApiOperation(value = "用户名是否存在",notes = "用户名是否存在")
    @ApiImplicitParams({
            @ApiImplicitParam(value = "用户名",name = "username",dataType = "String",required = true)
    })
    @GetMapping("/usernameIsExist")
    public JsonResult usernameIsExist(@RequestParam String username)

浏览器访问

访问默认UI /swagger2.html

访问第三方UI /doc.html