SpringBoot整合Swagger2

首先遵循 SpringBoot 的三板斧

第一步添加依赖

<!-- SwaggerUI 接口文档 http://{ip}:{prot}/swagger-ui.html -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>{version}</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>{version}</version>
</dependency>

第二步添加注解

@EnableSwagger2 // 启动 SwaggerUI，在启动类或 Swagger 配置类上添加该注解

第三步写配置

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {

/*
        // 可以添加多个 header 或参数
        ParameterBuilder aParameterBuilder = new ParameterBuilder();
        aParameterBuilder
                // 参数类型支持 header, cookie, body, query etc
                .parameterType("header")
                // 参数名
                .name("user-token")
                // 默认值
                .defaultValue("t122222")
                .description("用户登录凭证")
                // 指定参数值的类型
                .modelRef(new ModelRef("string"))
                // 非必需，这里是全局配置
                .required(false).build();
        List<Parameter> aParameters = new ArrayList<>();
        aParameters.add(aParameterBuilder.build());
*/

        return new Docket(DocumentationType.SWAGGER_2)
//        return new Docket(DocumentationType.SPRING_WEB)
                .apiInfo(apiInfo())
                .pathMapping("/")
                .select()// 选择那些路径和 api 会生成 document
                .apis(RequestHandlerSelectors.any())// 对所有 api 进行监控
                // 不显示错误的接口地址
                .paths(Predicates.not(PathSelectors.regex("/error.*")))// 错误 error 路径不监控
                .paths(Predicates.not(PathSelectors.regex("/actuator.*")))// 错误 error 路径不监控
                .paths(PathSelectors.regex("/.*"))// 对根下所有路径进行监控
                .paths(PathSelectors.any())   // 对所有路径进行监控
                // 自行修改为自己的包路径
//                .apis(RequestHandlerSelectors.basePackage("com.happyloves.zc.service.account.api"))
                .build()
//                .globalOperationParameters(aParameters)
                .enable(true);
    }

    private ApiInfo apiInfo() {return new ApiInfoBuilder()
                .title("API 接口")
                .description("API 接口文档")
                // 服务条款网址
//                .termsOfServiceUrl("https://www.google.com")
                .version("1.0")
//                .contact(new Contact("啦啦啦", "url", "email"))
                .build();}
}

扩展：swagger-bootstrap-ui 是 springfox-swagger 的增强 UI 实现，为 Java 开发者在使用 Swagger 的时候，能拥有一份简洁、强大的接口文档体验
项目地址
码云：https://gitee.com/xiaoym/swag…

GitHub:https://github.com/xiaoymin/S…

在线体验：http://swagger-bootstrap-ui.x…

项目文档：http://www.xiaominfo.com/swag…

代码集成示例

SpringBoot 在线 demo 地址：https://gitee.com/xiaoym/swag…

Spring Mvc 在线 demo 地址：https://gitee.com/xiaoym/swag…

添加依赖

<!-- swagger-bootstrap-ui 是 Swagger 的增强 UI 实现，使文档更友好一点儿 http://{ip}:{prot}/doc.html -->
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>swagger-bootstrap-ui</artifactId>
<version>1.9.6</version>
</dependency>

赵小胖个人博客