Setting up Swagger

Step 1: Adding Maven Dependency

To enable the Swagger in Spring Boot application with maven dependency, add the following dependencies in build configuration (pom.xml) file.

<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>2.7.0</version>
</dependency>
<dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>2.7.0</version>
</dependency>

Run the below command in terminal to install the dependencies:

mvn clean install

Step 2: Adding Gradle Dependency

To install the Swagger in Spring Boot application with gradle dependency, add the following dependencies in build configuration (build.gradle) file.

dependencies {
    implementation 'io.springfox:springfox-swagger2:2.7.0'
    implementation 'io.springfox:springfox-swagger-ui:2.7.0'
}

Run the below command to install the dependencies and build the project:

./gradlew clean build

Step 3: Configure Main Class

Enable main application file to use Swagger.

@EnableSwagger2 is used for it and after enabling it, main application file should like as follows:

Java

import org.springframework.boot.SpringApplication; 
import org.springframework.boot.autoconfigure.SpringBootApplication; 
import org.springframework.web.servlet.config.annotation.EnableWebMvc; 
  
import springfox.documentation.swagger2.annotations.EnableSwagger2; 
  
@SpringBootApplication
@EnableSwagger2
@EnableWebMvc
public class SwaggerApplication { 
    public static void main(String[] args) { 
        SpringApplication.run(SwaggerApplication.class, args); 
    } 
}

Step 4: Configure Swagger

Java

import org.springframework.context.annotation.Configuration; 
  
import springfox.documentation.builders.PathSelectors; 
import springfox.documentation.builders.RequestHandlerSelectors; 
import springfox.documentation.spi.DocumentationType; 
import springfox.documentation.spring.web.plugins.Docket; 
  
@Configuration
public class SwaggerConfig { 
  
   public Docket SwaggerApi() { 
       return new Docket(DocumentationType.SWAGGER_2) 
               .select() 
               .apis(RequestHandlerSelectors.any()) 
               .paths(PathSelectors.any()) 
               .build(); 
   }

Output:

Documentation is available at the following url for json format: http://server:port/v2/api-docs
- server: The server name or IP
- port: The server port

Documentation is available at the following url with UI: http://server:port/swagger-ui/index.html/

Note: If you are using spring security make sure to Whitelist the above url

Spring Boot – REST API Documentation using Swagger

REST stands for Representational State Transfer. REST is an architectural design pattern that defines constraints that are used in web service development. Swagger is a framework in which we can test our REST APIs for different HTTP requests i.e. :

GET
POST
PUT
DELETE

In this article, we will be discussing using Swagger for documenting APIs in Spring Boot applications.

Setting up Swagger

Step 1: Adding Maven Dependency

Step 2: Adding Gradle Dependency

Step 3: Configure Main Class

Java

Step 4: Configure Swagger

Java

Output:

Spring Boot – REST API Documentation using Swagger

Categories

Contact US

Setting up Swagger

Step 1: Adding Maven Dependency

Step 2: Adding Gradle Dependency

Step 3: Configure Main Class

Java

Step 4: Configure Swagger

Java

Output:

Spring Boot – REST API Documentation using Swagger

Similar Reads

Categories

Contact US