DEV Community: INDRANIL DUTTA

How to Configure Swagger 3 in a Spring Boot Application with Springfox

INDRANIL DUTTA — Sat, 18 May 2024 04:25:09 +0000

Introduction

Swagger, now part of the OpenAPI initiative, is a powerful tool for documenting and testing RESTful APIs. Using Springfox, you can easily integrate Swagger 3 (OpenAPI 3) with your Spring Boot application. In this article, I’ll guide you through the steps to set up and configure Swagger 3 using Springfox.

Prerequisites

Basic knowledge of Spring Boot
Java 8 or higher
Maven for dependency management

Step 1: Add Springfox Dependency

First, add the necessary Springfox dependency to your pom.xml file.

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-boot-starter</artifactId>
    <version>3.0.0</version>
</dependency>

Step 2: Configure Swagger

Create a configuration class to set up Swagger with Springfox. This is where you can customize various aspects of your API documentation.

import org.springframework.context.annotation.Bean;
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;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

@Configuration
@EnableSwagger2
public class SwaggerConfig {

    @Bean
    public Docket api() {
        return new Docket(DocumentationType.SWAGGER_2)
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.yourpackage"))
                .paths(PathSelectors.any())
                .build();
    }
}

In this configuration:

@EnableSwagger2: Enables Swagger 2 documentation.
Docket: Configures the Swagger 2 documentation with the base package for your controllers and paths to include.

Step 3: Annotate Your Controllers

Use annotations to document your endpoints. Springfox will automatically detect these annotations and include them in the generated documentation.

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api/v1/auth")
@Api(tags = "Authentication API", description = "API for user authentication")
public class AuthController {

    @GetMapping("/hello")
    @ApiOperation(value = "Hello World", notes = "Returns a greeting message")
    public String hello() {
        return "Hello, World!";
    }
}

In this example:

@Api: Defines a tag and description for the controller.
@ApiOperation: Provides metadata about the operation, including a value and notes.

Step 4: Configure Security for Swagger Endpoints

If you need to allow specific URLs to be accessed without authentication, configure your Spring Security settings accordingly.

import org.springframework.context.annotation.Configuration;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

@Configuration
@EnableWebSecurity
public class SecurityConfig extends WebSecurityConfigurerAdapter {

    @Override
    protected void configure(HttpSecurity http) throws Exception {
        http
            .authorizeRequests()
            .antMatchers("/api/v1/auth/**",
                         "/v3/api-docs",
                         "/v2/api-docs",
                         "/swagger-resources/**",
                         "/swagger-ui/**",
                         "/webjars/**").permitAll()
            .anyRequest().authenticated();
    }
}

Step 5: Access Swagger UI

After setting up and running your Spring Boot application, you can access the Swagger UI to view and test your API documentation.

Start your Spring Boot application.
Open your browser and navigate to http://localhost:8080/swagger-ui/.

You should see the Swagger UI with your documented API endpoints.

Conclusion

Integrating Swagger 3 with your Spring Boot application using Springfox is straightforward and immensely beneficial for documenting and testing your APIs. By following these steps, you can set up comprehensive and interactive API documentation that will make development and collaboration much easier.

You can connect with me on LinkedIn : Indranil Dutta

I hope this guide helps you set up Swagger 3 in your Spring Boot application using Springfox. If you have anything to share more, please comment below.

How to Prevent Sudden Crashes of Eclipse IDE on Ubuntu

INDRANIL DUTTA — Thu, 16 May 2024 04:39:31 +0000

Eclipse IDE is a powerful tool for developers, but like any complex software, it can sometimes experience sudden crashes, particularly on Ubuntu. These crashes can be frustrating and disruptive. This article will provide several solutions to help you stabilize Eclipse and improve your development experience.

1. Switch Display Driver from Wayland to Xorg

One common cause of Eclipse crashes on Ubuntu is the use of the Wayland display server. Switching to Xorg can often resolve these issues.

Steps to Switch from Wayland to Xorg:

Log Out of Your Current Session:
- Click on the system menu at the top right corner of your screen and select "Log Out."
Select Xorg at Login:
- At the login screen, click on your username.
- Before entering your password, click on the gear icon (⚙️) at the bottom right of the screen.
- Select "Ubuntu on Xorg."
- Enter your password and log in.

This change should make your system more stable and reduce the likelihood of Eclipse crashes.

2. Increase Memory Allocation in `eclipse.ini`

Eclipse relies on the JVM (Java Virtual Machine), and insufficient memory allocation can lead to crashes. Modifying the eclipse.ini file can help.

Steps to Modify `eclipse.ini`:

Locate the eclipse.ini File:
- Typically found in the Eclipse installation directory.
Edit Memory Settings:
- Open the eclipse.ini file with a text editor.
- Increase the memory settings as shown below:
```
 -Xms512m
 -Xmx2048m
 -XX:PermSize=256m
 -XX:MaxPermSize=512m
```

Save and close the file.

Increasing the -Xms and -Xmx values allocates more memory to Eclipse, which can help prevent crashes.

3. Update Graphics Drivers

Outdated or incompatible graphics drivers can also cause Eclipse to crash. Ensuring that your graphics drivers are up to date can improve stability.

Steps to Update Graphics Drivers:

Open Software & Updates:
- Go to the system menu and search for "Software & Updates."
Check for Updates:
- Go to the "Additional Drivers" tab.
- Select the latest available drivers for your graphics card.
- Apply the changes and restart your computer.

Updating your graphics drivers can resolve compatibility issues that might be causing Eclipse to crash.

4. Disable Unnecessary Plugins

Eclipse plugins can sometimes interfere with the IDE's stability. Disabling or uninstalling unnecessary plugins can help.

Steps to Manage Plugins:

Open Eclipse:
- Go to Help > Eclipse Marketplace or Help > Install New Software.
Manage Installed Software:
- In the Eclipse Marketplace, go to the "Installed" tab.
- Uninstall or disable any plugins you don't need.

By reducing the number of active plugins, you can improve Eclipse's performance and stability.

5. Use a Different Java Runtime Environment (JRE)

Eclipse may crash if there are issues with the current JRE. Switching to a different JRE can help.

Steps to Change JRE:

Install a New JRE:
- Open a terminal and install a new JRE, such as OpenJDK 11:
```
 sudo apt install openjdk-11-jdk
```
Configure Eclipse to Use the New JRE:
- Open Eclipse and go to Window > Preferences > Java > Installed JREs.
- Add the new JRE and set it as the default.

Using a different JRE can often resolve compatibility issues that lead to crashes.

Conclusion

Sudden crashes of Eclipse IDE on Ubuntu can be caused by various factors, including display drivers, memory allocation, graphics drivers, plugins, and JRE compatibility. By following the steps outlined above, you can significantly reduce the likelihood of crashes and enjoy a more stable development environment.

If you have any other tips or solutions that have worked for you, feel free to share them in the comments below!

You can connect on LinkedIn with me : Indranil Dutta

DEV Community: INDRANIL DUTTA

How to Configure Swagger 3 in a Spring Boot Application with Springfox

Introduction

Prerequisites

Step 1: Add Springfox Dependency

Step 2: Configure Swagger

Step 3: Annotate Your Controllers

Step 4: Configure Security for Swagger Endpoints

Step 5: Access Swagger UI

Conclusion

How to Prevent Sudden Crashes of Eclipse IDE on Ubuntu

1. Switch Display Driver from Wayland to Xorg

Steps to Switch from Wayland to Xorg:

2. Increase Memory Allocation in eclipse.ini

Steps to Modify eclipse.ini:

3. Update Graphics Drivers

Steps to Update Graphics Drivers:

4. Disable Unnecessary Plugins

Steps to Manage Plugins:

5. Use a Different Java Runtime Environment (JRE)

Steps to Change JRE:

Conclusion

2. Increase Memory Allocation in `eclipse.ini`

Steps to Modify `eclipse.ini`: