WebFlux and Swagger Integration

WebFlux and Swagger Integration

Try some samples
> git clone https://github.com/pgilad/spring-boot-webflux-swagger-starter

Go to that Project and Compile
> gradle clean build

List the Version
> jenv versions
  system
* 1.8 (set by /usr/local/opt/jenv/version)
  1.8.0.161
  10.0
  10.0.2
  11.0
  11.0.2
  oracle64-1.8.0.161
  oracle64-10.0.2
  oracle64-11.0.2

Switch the version
> jenv local 11.0

Check version
> java -version
java version "11.0.2" 2019-01-15 LTS

Start the service
> gradle bootRun

After that, we can visit the page
http://localhost:8080/swagger-ui.html

In my netty web flux project, here are the key changes
<!-- swagger -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>3.0.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>3.0.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-spring-webflux</artifactId>
<version>3.0.0-SNAPSHOT</version>
</dependency>
<repositories>
<repository>
<id>spring-snapshots</id>
<url>http://repo.spring.io/snapshot</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
<repository>
<id>swagger-snapshots</id>
<url>http://oss.jfrog.org/artifactory/oss-snapshot-local</url>
<snapshots>
<enabled>true</enabled>
</snapshots>
</repository>
<repository>
<id>spring-milestones</id>
<url>http://repo.spring.io/milestone</url>
</repository>
</repositories>

Important SwaggerConfig.java class
package com.sillycat.webfluxlatency.config;
import static springfox.documentation.builders.RequestHandlerSelectors.basePackage;
import java.util.Collections;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebFlux;
@Configuration
@EnableSwagger2WebFlux
public class SwaggerConfig {
@Bean
public Docket api() {
return new Docket(DocumentationType.SWAGGER_2).select().apis(basePackage("com.sillycat.webfluxlatency.web"))
.paths(PathSelectors.any()).build().apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfo("RESTful API", null, "API V1", null, null, null, null,
Collections.emptyList());
}
}

Important WebFluxConfig.java

package com.sillycat.webfluxlatency.config;

import org.springframework.context.annotation.Configuration;
import org.springframework.web.reactive.config.ResourceHandlerRegistry;
import org.springframework.web.reactive.config.WebFluxConfigurer;

@Configuration
public class WebfluxConfig implements WebFluxConfigurer {

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {

        registry.addResourceHandler("/swagger-ui.html**")
                .addResourceLocations("classpath:/META-INF/resources/");

        registry.addResourceHandler("/webjars/**")
                .addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

After that, we can visit these URLs to verify, it works well.
http://localhost:8083/actuator
http://localhost:8083/hello/1000
http://localhost:8083/swagger-ui.html#/


References:
https://code.massoudafrashteh.com/spring-boot-webflux-with-RDBMS/
https://stackoverflow.com/questions/48317431/generate-webservice-description-with-swagger-in-spring-webflux-environnment
https://github.com/deblockt/springfox/tree/feature/webflux
https://github.com/deblockt/springfox/tree/feature/webflux/springfox-spring-webflux
https://github.com/pgilad/spring-boot-webflux-swagger-starter