Spring Webflux V3 REST API Documentation + Swagger using OpenAPI3 V2

Springdoc-openapi library helps to automote the generation of REST API documentation .

For Spring boot V3 we need to use springdoc-openapi V2 . 

For integration between spring-boot and swagger-ui add the below dependency . Then the swagger will be available  at http://server:port/context-path/swagger-ui.html

<dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-starter-webflux-ui</artifactId>
  <version>2.1.0</version>
</dependency>

Sample API:

@RestController
public class EmployeeController {
	
	
	@Autowired
	EmployeeService service;

	@PostMapping(path="/employee", consumes="multipart/form-data")
	public Mono<Response> fileUpload(@RequestPart(name="file",required=true) FilePart file){
		return service.csvFileUpload(file);
		
	}
}

After running the application we can view the swagger using below url

http://localhost:8080/swagger-ui.html

Leave a Reply

Your email address will not be published. Required fields are marked *