← Back to list

Migrate from SpringFox Swagger-ui to SpringDocOpenApi

Introduce the SpringDocOpenApi dependency in POM.xml and comment out SpringFox. Choose versions of your liking.

Full Stack Developer · 2024-04-11 16:09 · 0 claps · 0.9 min read
#springdoc #open-api #microservices #swagger #springfox
Open on Medium ↗

Migrate from SpringFox Swagger-ui to SpringDocOpenApi

  1. Introduce the SpringDocOpenApi dependency in POM.xml and comment out SpringFox. Choose versions of your liking.
<!-- <dependency>
   <groupId>io.springfox</groupId>
   <artifactId>springfox-boot-starter</artifactId>
   <version>3.0.0</version>
  </dependency> -->
<dependency> 
   <groupId>org.springdoc</groupId> 
   <artifactId>springdoc-openapi-ui</artifactId> 
   <version>1.6.11</version> 
  </dependency>
  1. WebSecurityConfig class —
@Override
 public void configure(final WebSecurity web) throws Exception {
  //Replace previous web config like this 
  //web.ignoring().antMatchers("/v2/api-docs", "/configuration/**", "/swagger-resources/**", "/swagger-ui/**", "/swagger-ui.html", "/webjars/**",
  web.ignoring().antMatchers("/v3/api-docs/**","/v2/api-docs", "/configuration/**", "/swagger-resources/**", "/swagger-ui/**", "/swagger-ui.html", "/webjars/**",
    "/api-docs/**", "/mgmt/**","/","/uaa/**"/*,"/oauth/**"*/);
 }
  1. Replace Annotations —
@ApiOperation becomes @Operation(description ="This method does this")
@ApiParam(value="test") becomes @Parameter(description="test" @RequestParam(value ="test"))
@Api becomes @Tag
@ApiIgnore becomes @Hidden
@ApiResponse(code = 400, message = "Bad Req")  becomes @ApiResponse(responseCode = "404", description = "Not found")
  1. Replace Docket beans with GroupedOpenApi beans -
/* GroupedOpenApi allows you to group your APIs based on packages, paths, etc.
 You can then select it from swagger-ui by selecting a respective definition.
 Also, GroupedOpenApi is much cleaner than Docket beans.
*/
@Bean
    public GroupedOpenApi publicApi() {
        return GroupedOpenApi.builder()
                .group("public-apis")
                .pathsToMatch("/**")
                .pathsToExlude("/actuator/**")
                .build();
    }

    @Bean
    public GroupedOpenApi actuatorApi() {
        return GroupedOpenApi.builder()
                .group("actuators")
                .pathsToMatch("/actuators/**")
                .build();
    }

메타데이터
post_id
bd6c3b8464ca
slug
migrate-from-springfox-swagger-ui-to-springdocopenapi-bd6c3b8464ca
url
https://medium.com/@ByteCodeBlogger/migrate-from-springfox-swagger-ui-to-springdocopenapi-bd6c3b8464ca
canonical_url
https://medium.com/@ByteCodeBlogger/migrate-from-springfox-swagger-ui-to-springdocopenapi-bd6c3b8464ca
author_url
https://medium.com/@ByteCodeBlogger
status
ok
fetched_at
2026-07-25 11:21:33