By default all the rest apis are visible in swagger documentation. If you want to hide a rest API from swagger documentation, you can achieve this by @Hidden annotation.
Example
@Hidden
@Operation(summary = "about me", description = "Details about myself")
@GetMapping("/myself")
public ResponseEntity<Map<String, Object>> aboutMe() {
Map<String, Object> result = new HashMap<>();
return ResponseEntity.ok(result);
}
Find the below working application.
Step 1: Create new maven project ‘openapi-hide-an-api’.
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-hide-an-api</artifactId>
<version>1</version>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.6.4</version>
</parent>
<properties>
<java.version>1.8</java.version>
<maven.compiler.source>${java.version}</maven.compiler.source>
<maven.compiler.target>${java.version}</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.report.outputEncoding>UTF-8</project.report.outputEncoding>
</properties>
<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 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.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import io.swagger.v3.oas.annotations.Hidden;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import io.swagger.v3.oas.annotations.enums.ParameterIn;
import io.swagger.v3.oas.annotations.media.Schema;
@RestController
@RequestMapping(value = "/api/v1/users")
@CrossOrigin("*")
public class UserController {
@Operation(summary = "get users by city", description = "get users by city", parameters = {
@Parameter(name = "city", in = ParameterIn.PATH, description = "city ex: Bangalore", schema = @Schema(type = "string", allowableValues = {
"Bangalore", "Chennai", "Hyderabad" })) })
@GetMapping("/by-city/{city}")
public ResponseEntity<Map<String, Object>> infoByCity(@PathVariable(name = "city") String city) {
Map<String, Object> result = new HashMap<>();
return ResponseEntity.ok(result);
}
@Hidden
@Operation(summary = "about me", description = "Details about myself")
@GetMapping("/myself")
public ResponseEntity<Map<String, Object>> aboutMe() {
Map<String, Object> result = new HashMap<>();
return ResponseEntity.ok(result);
}
}
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.
Open the url ‘http://localhost:8080/swagger-ui/index.html’ to check swagger documentation.
From the above screen, you can confirm that the api ‘/api/v1/users/myself’ is hidden.
You can download the complete working application from this link.
Previous Next Home
No comments:
Post a Comment