SpringBoot整合Swagger3的流程详解

<!-- swagger -->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.9.6</version>
</dependency>

@Configuration
@EnableOpenApi
public class SwaggerConfig {
	@Bean
    Docket docket(){
		return new Docket(DocumentationType.SWAGGER_2)
	}
}

@Bean
public ApiInfo apiInfo(){
    return new ApiInfo("这是Swagger文档",				//title名称
            "归来仍是少年",								//简介
            "1.0",										//版本
            "urn:tos",									//服务url
            new Contact(								//配置联系作者的方式
            	"xxx",									//作者名称
            	"https://www.baidu.com",				//连接
            	"xxxx@qq.com"),							//作者邮箱
            "Apache 2.0",								//许可证
            "http://www.apache.org/licenses/LICENSE-2.0",		//许可证地址
            new ArrayList<>());							//供应商的拓展
}

@Bean
Docket docket_A(){
    return new Docket(DocumentationType.SWAGGER_2)
            .groupName("TestA");
}

@Bean
Docket docket_B (){
    return new Docket(DocumentationType.SWAGGER_2)
            .groupName("TestB");
}


@Bean
Docket docket(Environment environment){

    boolean result = environment.acceptsProfiles(Profiles.of("dev"));

    return new Docket(DocumentationType.SWAGGER_2)
    		.groupName("Splay")				//默认分组Default改为Splay
            .apiInfo(apiInfo())				//注入主页面信息
            .enable(true)                   //是否启用swagger
            .select()						//扫描
            /**
             * apis指定要扫描的方式
             * 1. basePackage(): 指定扫描的包
             * 2. any(): 全部扫描
             * 3. none(): 都不扫描
             * 4. withClassAnnotation(): 通过类注解扫描
             * 5. withMethodAnnotation(): 通过方法上的注解扫描
             */
            .apis(RequestHandlerSelectors.basePackage("com.splay.controller"))
            /**
             * paths过滤不需要
             * 1. ant(): 制定路径
             * 2. none(): 全都不过滤
             * 3. any(): 都过滤
             * 4. regex(): 正则表达式
             */
            //.paths(PathSelectors.ant("/splay/**"))		//过滤不需要的路径
            .build();
}

@Controller
public class RouterController {
    
    @GetMapping("/hello")
    @ResponseBody
    public String toHello(){
        return "Hello Swagger";
    }
}

@Data
@NoArgsConstructor
@AllArgsConstructor
@ApiModel("用户类" )
public class User {

    @ApiModelProperty("用户名")
    private String username;

    @ApiModelProperty("密码")
    private String password;

}

@Controller
@Api(tags = "路由控制类")
public class RouterController {
	
}

@PostMapping("/user")
@ResponseBody
@ApiOperation("返回用户信息")			//接口名称、以及参数
public User sendUserMessage(@ApiParam("用户帐号") String username){
    System.out.println(username);
    return new User("admin", "123456");
}