【二】springboot整合自定义swagger

简介: 【二】springboot整合自定义swagger

       介绍:接下来我会把学习阶段学到的框架等知识点进行整合,每一次整合是在前一章的基础上进行的,所以后面的整合不会重复放前面的代码。每次的demo我放在结尾,本次是接着上一章的内容延续的,只增加新增的或者修改的代码。

       场景:当在swagger上进行接口测试时,想要新增token参数,如下:

        因此,swagger的默认配置是不行的(直接在启动类上面加@EnableSwagger2注解开启)

       开启默认配置的swagger:

        若想实现以上场景,需要使用自定义swagger配置。

第一步:新增配置类

       展示目录结构:

       swagger配置文件:

@Configuration
@EnableSwagger2
@Profile("swagger")
public class SwaggerConfig {
  /**
   * 创建API应用 apiInfo() 增加API相关信息
   * 通过select()函数返回一个ApiSelectorBuilder实例,用来控制哪些接口暴露给Swagger来展现,
   * 本例采用指定扫描的包路径来定义指定要建立API的目录。
   *
   * @return
   */
  @Bean
  public Docket createRestApi() {
    // 选择那些路径和api会生成document
    return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).pathMapping("/").select()
        // 对所有api进行监控
        .apis(RequestHandlerSelectors.any())
        .apis(RequestHandlerSelectors.withClassAnnotation(RestController.class)).build()
        // 配置token
        .globalOperationParameters(setHeaderToken());
  }
 
  /**
   * 配置token
   * 
   * @return
   */
  private List<Parameter> setHeaderToken() {
    ParameterBuilder tokenPar = new ParameterBuilder();
    List<Parameter> pars = new ArrayList<>();
    tokenPar.name("Authorization").description("token").modelRef(new ModelRef("string")).parameterType("header")
        .required(false).build();
    pars.add(tokenPar.build());
    return pars;
  }
 
  /**
   * 创建该API的基本信息(这些基本信息会展现在文档页面中)
   * 
   * @return
   */
  private ApiInfo apiInfo() {
    return new ApiInfoBuilder().title("测试接口文档").description("测试接口文档").version("1.0").build();
  }
 
}

@Configuration:用于定义配置类,可替换xml配置文件,被注解的类内部包含有一个或多个被@Bean注解的方法,这些方法将会被AnnotationConfigApplicationContext或AnnotationConfigWebApplicationContext类进行扫描,并用于构建bean定义,初始化Spring容器,简而言之就是在Spring启动时会将该类识别成一个配置类

@EnableSwagger2:开启swagger,此处也需要使用。

       到此处即可完成使用自定义的swagger,若有其他需求修改该配置类即可,另外此处另外提到一个注解Profile,此处可以不使用,在实际开发中可能存在多个环境,测试环境,正式环境等,可能需要使用不同的配置,此时可以使用Profile注解。

       @Profile("swagger"):指定组件在哪个环境的情况下才能被注册到容器中,不指定,任何环境下都能注册这个组件。

       实际使用:

       yml配置文件在开发时可能存在多个,因此可以指定具体哪一个环境可以开启该配置,如下图,在想要开启该配置的环境的yml文件里加上如下代码即可。

        active后面的值是配置文件里面profile注解里面的参数值。profile注解的具体使用就不展开了。

       到此完毕,接下来会继续更新加强整合,尽情期待。

       访问地址:http://localhost:8082/swagger-ui.html或者http://localhost:8082/doc.html

目录
相关文章
|
25天前
|
Java 测试技术 API
详解Swagger:Spring Boot中的API文档生成与测试工具
详解Swagger:Spring Boot中的API文档生成与测试工具
35 4
|
2月前
|
SQL JSON Java
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
这篇文章介绍了如何在Spring Boot项目中整合MyBatis和PageHelper进行分页操作,并且集成Swagger2来生成API文档,同时定义了统一的数据返回格式和请求模块。
76 1
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
|
2月前
|
前端开发 Java 程序员
springboot 学习十五:Spring Boot 优雅的集成Swagger2、Knife4j
这篇文章是关于如何在Spring Boot项目中集成Swagger2和Knife4j来生成和美化API接口文档的详细教程。
195 1
|
3月前
|
前端开发 Java Spring
【非降版本解决】高版本Spring boot Swagger 报错解决方案
【非降版本解决】高版本Spring boot Swagger 报错解决方案
|
3月前
|
Java Spring
springboot 集成 swagger 2.x 和 3.0 以及 Failed to start bean ‘documentationPluginsBootstrapper‘问题的解决
本文介绍了如何在Spring Boot项目中集成Swagger 2.x和3.0版本,并提供了解决Swagger在Spring Boot中启动失败问题“Failed to start bean ‘documentationPluginsBootstrapper’; nested exception is java.lang.NullPointerEx”的方法,包括配置yml文件和Spring Boot版本的降级。
springboot 集成 swagger 2.x 和 3.0 以及 Failed to start bean ‘documentationPluginsBootstrapper‘问题的解决
|
4月前
|
Java API Spring
springboot集成swagger
这篇文章介绍了如何在Spring Boot项目中集成Swagger 2.10.0来生成API文档,包括添加依赖、编写配置类、创建接口文档,并使用Knife4j美化Swagger界面。
|
4月前
|
Java
SpringBoot 配置 Swagger
SpringBoot 配置 Swagger
48 0
|
5月前
|
数据可视化 Java API
Spring Boot与Swagger的集成
Spring Boot与Swagger的集成
|
5月前
|
Java API 开发者
在Spring Boot中集成Swagger API文档
在Spring Boot中集成Swagger API文档
|
5月前
|
JSON 缓存 Java
Spring Boot集成 Swagger2 展现在线接口文档
本节课详细分析了 Swagger 的优点,以及 Spring Boot 如何集成 Swagger2,包括配置,相关注解的讲解,涉及到了实体类和接口类,以及如何使用。最后通过页面测试,体验了 Swagger 的强大之处,基本上是每个项目组中必备的工具之一,所以要掌握该工具的使用,也不难。