Using @ApiParam annotation, we can specify the query parameters.
Example
public ResponseEntity<Map<String, Object>> infoByName(
@ApiParam(name = "firstName", value = "firstName ex: krishna", required = false) @RequestParam(name = "firstName", required = false) String firstName,
@ApiParam(name = "lastName", value = "lastName ex: Krishna", required = false) @RequestParam(name = "lastName", required = false) String lastName) {
..........
.........
}
Above snippet document two query parameters
a. firstName
b. lastName
Find the below working application.
Step 1: Create new maven project ‘swagger-query-parameters’.
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>swagger-query-parameters</artifactId>
<version>1</version>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.3.12.RELEASE</version>
</parent>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
</dependencies>
</project>
Step 3: Define SwaggerConfig class.
SwaggerConfig.java
package com.sample.app.config;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.stereotype.Component;
import springfox.documentation.builders.ApiInfoBuilder;
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.EnableSwagger2;
@Component
@EnableAutoConfiguration
@EnableSwagger2
public class SwaggerConfig {
@Bean
public Docket docketApi() {
return new Docket(DocumentationType.SWAGGER_2).apiInfo(apiInfo()).select().paths(PathSelectors.any()).build();
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder().title("Spring boot swagger demo application").description("REST APIs for spring boot service")
.license("Apache License Version 2.0").licenseUrl("http://www.apache.org/licenses/LICENSE-2.0.html")
.version("2.0").build();
}
}
Step 4: Define UserController class.
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.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
@RestController
@RequestMapping(value = "/api/v1/users")
@Api(tags = { "user" })
@CrossOrigin("*")
public class UserController {
@ApiOperation(value = "Get user details by either firstName or lastName", notes = "This API will get information of user by first or lastName")
@GetMapping("/by-name")
public ResponseEntity<Map<String, Object>> infoByName(
@ApiParam(name = "firstName", value = "firstName ex: krishna", required = false) @RequestParam(name = "firstName", required = false) String firstName,
@ApiParam(name = "lastName", value = "lastName ex: Krishna", required = false) @RequestParam(name = "lastName", required = false) String lastName) {
Map<String, Object> myDetails = new HashMap<>();
if (firstName != null) {
myDetails.put("firstName", firstName);
}
if (lastName != null) {
myDetails.put("lastName", lastName);
}
return ResponseEntity.ok(myDetails);
}
}
Step 5: 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.
Open the url ‘http://localhost:8080/swagger-ui.html’ to experiment with swagger ui.
You can download the complete working application from this link.
Previous Next Home
No comments:
Post a Comment