【二】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

目录
相关文章
|
11月前
|
JSON Java API
微服务——SpringBoot使用归纳——Spring Boot集成 Swagger2 展现在线接口文档——Swagger2 的使用
本文详细介绍了Swagger2的使用方法,包括在Spring Boot项目中的配置与应用。重点讲解了Swagger2中常用的注解,如实体类上的`@ApiModel`和`@ApiModelProperty`,Controller类上的`@Api`、`@ApiOperation`以及参数上的`@ApiParam`等。通过示例代码展示了如何为实体类和接口添加注解,并在页面上生成在线接口文档,实现接口测试。最后总结了Swagger的优势及其在项目开发中的重要性,提供了课程源代码下载链接供学习参考。
790 0
微服务——SpringBoot使用归纳——Spring Boot集成 Swagger2 展现在线接口文档——Swagger2 的使用
|
11月前
|
缓存 Java API
微服务——SpringBoot使用归纳——Spring Boot集成 Swagger2 展现在线接口文档——Swagger2 的配置
本文介绍了在Spring Boot中配置Swagger2的方法。通过创建一个配置类,添加`@Configuration`和`@EnableSwagger2`注解,使用Docket对象定义API文档的详细信息,包括标题、描述、版本和包路径等。配置完成后,访问`localhost:8080/swagger-ui.html`即可查看接口文档。文中还提示了可能因浏览器缓存导致的问题及解决方法。
1180 0
微服务——SpringBoot使用归纳——Spring Boot集成 Swagger2 展现在线接口文档——Swagger2 的配置
|
11月前
|
Java Maven 微服务
微服务——SpringBoot使用归纳——Spring Boot集成 Swagger2 展现在线接口文档——Swagger2 的 maven 依赖
在项目中使用Swagger2工具时,需导入Maven依赖。尽管官方最高版本为2.8.0,但其展示效果不够理想且稳定性欠佳。实际开发中常用2.2.2版本,因其稳定且界面友好。以下是围绕2.2.2版本的Maven依赖配置,包括`springfox-swagger2`和`springfox-swagger-ui`两个模块。
465 0
|
11月前
|
前端开发 Java API
微服务——SpringBoot使用归纳——Spring Boot集成 Swagger2 展现在线接口文档—— Swagger 简介
第6课介绍了在Spring Boot中集成Swagger2以展示在线接口文档的方法。随着前后端分离架构的发展,API文档成为连接前端与后端开发的重要纽带。然而,代码更新频繁导致文档难以同步维护,Swagger2解决了这一问题。通过Swagger,在线API文档不仅方便了接口调用方查看和测试,还支持开发者实时测试接口数据。本文使用Swagger 2.2.2版本,讲解如何在Spring Boot项目中导入并配置Swagger2工具,从而高效管理接口文档。
370 0
|
Java 测试技术 API
详解Swagger:Spring Boot中的API文档生成与测试工具
详解Swagger:Spring Boot中的API文档生成与测试工具
1081 4
|
SQL JSON Java
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
这篇文章介绍了如何在Spring Boot项目中整合MyBatis和PageHelper进行分页操作,并且集成Swagger2来生成API文档,同时定义了统一的数据返回格式和请求模块。
672 1
mybatis使用三:springboot整合mybatis,使用PageHelper 进行分页操作,并整合swagger2。使用正规的开发模式:定义统一的数据返回格式和请求模块
|
前端开发 Java 程序员
springboot 学习十五:Spring Boot 优雅的集成Swagger2、Knife4j
这篇文章是关于如何在Spring Boot项目中集成Swagger2和Knife4j来生成和美化API接口文档的详细教程。
2308 1
|
数据可视化 Java API
Spring Boot与Swagger的集成
Spring Boot与Swagger的集成
|
Java API 开发者
在Spring Boot中集成Swagger API文档
在Spring Boot中集成Swagger API文档
|
前端开发 Java Spring
【非降版本解决】高版本Spring boot Swagger 报错解决方案
【非降版本解决】高版本Spring boot Swagger 报错解决方案
1150 3