Spring Boot集成Swagger2

<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>

package cc.bnblogs.swagger_study.config;

import org.springframework.context.annotation.Configuration;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
import org.springframework.context.annotation.Bean;
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;

@EnableSwagger2
@Configuration
public class SwaggerConfig {

    @Bean
    public Docket createRestApi() {
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .select()
                //为当前包路径,控制器类包
                .apis(RequestHandlerSelectors.basePackage("cc.bnblogs.swagger_study.controller"))
                .paths(PathSelectors.any())
                .build();
    }
    private ApiInfo apiInfo() {
        return new ApiInfoBuilder()
                //页面标题
                .title("Spring Boot集成Swagger2构建RESTful API")
                //创建人
                .contact(new Contact("barney", "https://hugo.bnblogs.cc",  "xxx@xxx.com"))
                //版本号
                .version("1.0")
                //描述
                .description("演示系统API描述")
                .build();
    }
}

any() // 扫描所有，项目中的所有接口都会被扫描到
none() // 不扫描接口
withMethodAnnotation(final Class<? extends Annotation> annotation)// 通过方法上的注解扫描withMethodAnnotation(GetMapping.class) // 只扫描get请求
withClassAnnotation(final Class<? extends Annotation> annotation) // 通过类上的注解扫描withClassAnnotation(RestController.class) // 只扫描有RestController注解的类中的接口
basePackage(final String basePackage) // 根据包路径扫描接口

any() // 任何请求都扫描
none() // 任何请求都不扫描
regex(final String pathRegex) // 通过正则表达式控制，返回true扫描，false不扫描
ant(final String antPattern) // 通过ant()表达式控制，返回true扫描，false不扫描

@Bean
public Docket docket(Environment environment) {
    // 设置要显示swagger的环境
    Profiles of = Profiles.of("dev", "test");
    // 判断当前是处于dev或test环境，通过 enable() 接收此参数判断是否要显示
    boolean b = environment.acceptsProfiles(of);

    return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo())
        .ignoredParameterTypes(HttpServletRequest.class)
        .enable(b) // 配置是否启用Swagger，如果是false，在浏览器将无法访问
        .select()
        .apis(RequestHandlerSelectors.basePackage("cc.bnblogs.swagger_study.controller")).build();
}

@Bean
public Docket docketDemo() {

    return new Docket(DocumentationType.SWAGGER_2)
        .groupName("demo")
        .apiInfo(apiInfo())
        .select()
        .paths(PathSelectors.ant("/demo/**"))
        .build();
}

@Bean
public Docket docketHello() {

    return new Docket(DocumentationType.SWAGGER_2)
        .groupName("hello")
        .apiInfo(apiInfo())
        .select()
        .paths(PathSelectors.ant("/hello/**"))
        .build();
}

@ApiModel("学生表")
public class Student {
    
    @ApiModelProperty("学号")
    private Integer id;
    
    @ApiModelProperty("姓名")
    private String name;
}

@Bean
public Docket docket(){
    // 新建一个全局参数
    Parameter token = new ParameterBuilder().name("token")
        // 描述信息
        .description("用户登录令牌")
        // 该参数放在请求头
        .parameterType("header") // 也可以设置query参数，
        // 参数的类型
        .modelRef(new ModelRef("String"))
        // 该参数必填
        .required(true)
        .build();

    List<Parameter> parameters = new ArrayList<>();
    parameters.add(token);

    return new Docket(DocumentationType.SWAGGER_2)
        .globalOperationParameters(parameters).apiInfo(apiInfo());

}

@Api(tags = "demo接口")
@RestController
@RequestMapping("/demo/")
public class DemoController {
    @GetMapping
    @ApiOperation("输出hello world")
    public String greet() {
        return "Hello, World";
    }

    @PostMapping("/{id}/")
    @ApiOperation("提交一个id")
    @ApiImplicitParams({
        @ApiImplicitParam(name = "id", value = "编号", example = "1"),
        @ApiImplicitParam(name = "name", value = "姓名", example = "admin")
    })
    public Integer addInfo(@RequestParam Integer id,
                           @RequestParam String name) {
        System.out.println(name);
        return id;
    }
}