Spring: openAPI: Document allowable values to the query parameter

By defining the 'schema' attribute of @Parameter annotation, we can document the allowable values to the query parameter.

 

Example

@GetMapping("/by-city")
public ResponseEntity<Map<String, Object>> infoByName(
		@Parameter(name = "city", description = "city ex: Bangalore", required = true, schema = @Schema(type = "string", allowableValues = {"Bangalore", "Chennai","Hyderabad" })) 
		@RequestParam(name = "city", required = false) String firstName) {

		........
		........
}

 

Above snippet generate below documentation.

 

Find the below working application.

 

Step 1: Create new maven project ‘openapi-document-allowable-values-of-query-parameter’.

 

Step 2: Update pom.xml with maven dependencies.

 

pom.xml

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.sample.app</groupId>
	<artifactId>openapi-document-allowable-values-of-query-parameter</artifactId>
	<version>1</version>

	<parent>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-starter-parent</artifactId>
		<version>2.6.4</version>
	</parent>

	<dependencies>
		<dependency>
			<groupId>org.springframework.boot</groupId>
			<artifactId>spring-boot-starter-web</artifactId>
		</dependency>


		<dependency>
			<groupId>org.springdoc</groupId>
			<artifactId>springdoc-openapi-ui</artifactId>
			<version>1.6.6</version>
		</dependency>


	</dependencies>

</project>

 

Step 3: Define UserController.

 

UserController.java

 

package com.sample.app.controller;

import java.util.HashMap;
import java.util.Map;

import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.CrossOrigin;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.media.Schema;

@RestController
@RequestMapping(value = "/api/v1/users")
@CrossOrigin("*")
public class UserController {

	@GetMapping("/by-city")
	public ResponseEntity<Map<String, Object>> infoByName(
			@Parameter(name = "city", description = "city ex: Bangalore", required = true, schema = @Schema(type = "string", allowableValues = {
					"Bangalore", "Chennai",
					"Hyderabad" })) @RequestParam(name = "city", required = false) String firstName) {

		Map<String, Object> usersByCity = new HashMap<>();

		return ResponseEntity.ok(usersByCity);

	}

}

 

Step 4: Define main application class.

 

App.java

 

package com.sample.app;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class App {
	public static void main(String[] args) {

		SpringApplication.run(App.class, args);

	}
}

 

Total project structure looks like below.

 

 

Run App.java and open the url ‘http://localhost:8080/swagger-ui/index.html’ to see the documentation.

 

You can download complete working application from this link.

 

Previous                                                    Next                                                    Home