📘 Premium Read: Access my best content on
Medium member-only articles
— deep dives into Java, Spring Boot, Microservices, backend architecture, interview preparation, career advice, and industry-standard best practices.
✅ Some premium posts are free to read — no account needed.
Follow me on Medium to stay updated and support my writing.
🎓 Top 10 Udemy Courses (Huge Discount):
Explore My Udemy Courses
— Learn through real-time, project-based development.
▶️ Subscribe to My YouTube Channel (172K+ subscribers):
Java Guides on YouTube
In the previous tutorial, we have seen Spring Boot REST API Documentation with Swagger.
In this tutorial, we will learn how to configure Swagger UI to include a JSON Web Token (JWT) when it calls our API.
Building Real-Time REST APIs with Spring Boot course at https://courses.javaguides.net/p/building-rest-api-with-spring-boot
We will add Swagger configuration code in the Spring boot application to enable the Authorization option on Swagger UI to include JWT.
Swagger UI provides custom configurations to set up JWT, which can be helpful when dealing with our application authorization. After authorizing in Swagger UI, all the requests will automatically include our JWT.
Adding Maven Dependency to Spring Boot Project
In this example, we'll be using springfox-boot-starter, which includes all the necessary dependencies to start working with Swagger and Swagger UI.
Let's pom.xml file and add the below maven dependencies to it:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-boot-starter</artifactId>
<version>3.0.0</version>
</dependency>
Swagger Configuration
Let's create a SwaggerConfig class and annotate with @Configuration annotation. The configuration of Swagger mainly centers around the Docket bean so let's add the below code to SwaggerConfig class:
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.service.*;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spi.service.contexts.SecurityContext;
import springfox.documentation.spring.web.plugins.Docket;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
@Configuration
public class SwaggerConfig {
public static final String AUTHORIZATION_HEADER = "Authorization";
private ApiKey apiKey(){
return new ApiKey("JWT", AUTHORIZATION_HEADER, "header");
}
private ApiInfo apiInfo(){
return new ApiInfo(
"Spring Boot Blog REST APIs",
"Spring Boot Blog REST API Documentation",
"1",
"Terms of service",
new Contact("Ramesh Fadatare", "www.javaguides.net", "ramesh@gmail.com"),
"License of API",
"API license URL",
Collections.emptyList()
);
}
@Bean
public Docket api(){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.securityContexts(Arrays.asList(securityContext()))
.securitySchemes(Arrays.asList(apiKey()))
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
private SecurityContext securityContext(){
return SecurityContext.builder().securityReferences(defaultAuth()).build();
}
private List<SecurityReference> defaultAuth(){
AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
authorizationScopes[0] = authorizationScope;
return Arrays.asList(new SecurityReference("JWT", authorizationScopes));
}
}
Let's understand the above code.
We have added ApiKey to include JWT as an authorization header:
public static final String AUTHORIZATION_HEADER = "Authorization";
private ApiKey apiKey() {
return new ApiKey("JWT", "Authorization", "header");
}
Next, let's configure the JWT SecurityContext with a global AuthorizationScope:
private SecurityContext securityContext(){
return SecurityContext.builder().securityReferences(defaultAuth()).build();
}
private List<SecurityReference> defaultAuth(){
AuthorizationScope authorizationScope = new AuthorizationScope("global", "accessEverything");
AuthorizationScope[] authorizationScopes = new AuthorizationScope[1];
authorizationScopes[0] = authorizationScope;
return Arrays.asList(new SecurityReference("JWT", authorizationScopes));
}
And then, we configured our API Docket bean to include API info, security contexts, and security schemes:
private ApiInfo apiInfo(){
return new ApiInfo(
"Spring Boot Blog REST APIs",
"Spring Boot Blog REST API Documentation",
"1",
"Terms of service",
new Contact("Ramesh Fadatare", "www.javaguides.net", "ramesh@gmail.com"),
"License of API",
"API license URL",
Collections.emptyList()
);
}
@Bean
public Docket api(){
return new Docket(DocumentationType.SWAGGER_2)
.apiInfo(apiInfo())
.securityContexts(Arrays.asList(securityContext()))
.securitySchemes(Arrays.asList(apiKey()))
.select()
.apis(RequestHandlerSelectors.any())
.paths(PathSelectors.any())
.build();
}
Accessing Swagger UI
Let's say we are creating a blog application and when we start our application, we can access the Swagger UI at:
Here's a look at the Swagger UI with Authorize button:
Complete Course and Source Code
Related Spring Boot and Microservices Tutorials/Guides:
The Hidden Magic of Spring Boot: Secrets Every Developer Should Know
What Happens When You Hit a Spring Boot REST API Endpoint (Behind the Scenes)
Spring Boot Exception Handling
Build CRUD REST API with Spring Boot, Spring Data JPA, Hibernate, and MySQL
Spring Boot DELETE REST API: @DeleteMapping Annotation
Spring Boot PUT REST API — @PutMapping Annotation
Spring Boot POST REST API
Spring Boot GET REST API — @GetMapping Annotation
Spring Boot REST API with Request Param | Spring Boot Course
Spring Boot REST API with Path Variable — @PathVariable
Chapter 13: Understanding @SpringBootApplication Annotation | Spring Boot Course
Chapter 5: Create Spring Boot Project and Build Hello World REST API | Spring Boot Course
10 Real-World Spring Boot Architecture Tips Every Developer Should Follow
Top 10 Spring Boot Tricks Every Java Developer Should Know
Debugging Spring Dependency Injection Issues - Very Important
Common Code Smells in Spring Applications — How to Fix Them
Spring Boot + OpenAI ChatGPT API Integration Tutorial
Spring Boot Course -> New Series on Medium ❤️
Spring Boot Microservices with RabbitMQ Example
React JS + Spring Boot Microservices
Dockerizing a Spring Boot Application
How to Change the Default Port in Spring Boot
How to Change Context Path in Spring Boot
Top 10 Spring Boot REST API Mistakes and How to Avoid Them (2025 Update)
Spring Boot REST API Best Practices
Spring Boot Security Database Authentication Example Tutorial
Spring Boot Security Form-Based Authentication
Spring Boot Security In-Memory Authentication
What is Spring Boot Really All About?
Why Spring Boot over Spring?
Top 10 Spring Boot Key Features That You Should Know
Spring vs Spring Boot
Setting Up the Development Environment for Spring Boot
Spring Boot Auto-Configuration: A Quick Guide
Spring Boot Starters
Quick Guide to Spring Boot Parent Starter
Spring Boot Embedded Servers
Spring Boot Thymeleaf Hello World Example
Chapter 10: Spring Boot DevTools | Spring Boot Course
Chapter 13: Spring Boot REST API That Returns JSON | Spring Boot Course
Spring Boot REST API That Returns List of Java Objects in JSON Format
Top 10 Spring Boot Mistakes and How to Avoid Them
Advanced Spring Boot Concepts that Every Java Developer Should Know
What Are Microservices in Spring Boot?
Integrating React Frontend with Spring Boot ChatGPT API (Step-by-Step Guide)
Build a Chatbot Using Spring Boot, React JS, and ChatGPT API
Top 10 Mistakes in Spring Boot Microservices and How to Avoid Them (With Examples)
Spring Boot Security Best Practices: Protecting Your Application from Attacks
🔄 Dependency Injection in Spring (Explained with Coding Examples)
⚙️ How Spring Container Works Behind the Scenes
How Spring Container Works Behind the Scenes (Spring Container Secrets Revealed!)
Spring @Component vs @Bean vs @Service vs @Repository Explained
How Component Scanning Works Behind the Scenes in Spring
How Spring Autowiring Works Internally
Top 20 Spring Boot Best Practices for Java Developers
Build Spring Boot React Full Stack Project — Todo App [2025 Update]
Spring vs Spring MVC vs Spring Boot
Spring Boot Best Practices: Use DTOs Instead of Entities in API Responses
Spring Boot DTO Tutorial (Using Java record) – Complete CRUD REST API Implementation
Spring Boot Architecture: Controller, Service, Repository, Database and Architecture Flow
Java Stream filter() Method with Real-World Examples
Spring Boot Auto Configuration Explained | How It Works
Spring Boot Profiles: How to Manage Environment-Based Configurations
Create a Custom Spring Boot Starter | Step-by-Step Guide
Spring Boot Starter Modules Explained | Auto-Configuration Guide
Deploy Spring Boot Applications with Profile-Based Settings | Step-by-Step Guide
Spring Boot Performance Tuning: 10 Best Practices for High Performance
Spring Boot @ComponentScan Annotation | Customizing Component Scanning
Difference Between @RestController and @RequestMapping in Spring Boot
Spring Boot @Cacheable Annotation – Improve Performance with Caching
Spring Boot Redis Cache — @Cacheable Complete Guide
When to Use @Service, @Repository, @Controller, and @Component Annotations in Spring Boot
Why, When, and How to Use @Bean Annotation in Spring Boot App
Java Spring Boot vs. Go (Golang) for Backend Development in 2025
Is Autowired Annotation Deprecated in Spring Boot? Everything You Need to Know
🚫 Stop Making These Common Mistakes in Spring Boot Projects
Top 10 Mind-Blowing Spring Boot Tricks for Beginners
Why Choose Spring Boot Over Spring Framework? | Key Differences and Benefits
How to Run a Spring Boot Application | 5 Easy Ways for Developers
What is AutoConfiguration in Spring Boot? | Explained with Example
Customize Default Configuration in Spring Boot | 5 Proven Ways
Chapter 12: Understanding SpringApplication.run() Method Internals | Spring Boot Course
What is CommandLineRunner in Spring Boot?
How to Create Custom Bean Validation in Spring Boot
Can You Build a Non-Web Application with Spring Boot?
How to Disable Auto-Configuration in Spring Boot (Step-by-Step Guide)
Top 25 Spring Boot Interview Questions and Answers for Beginners
How to Use Java Records with Spring Boot
Spring Boot Constructor Injection Explained with Step-by-Step Example
🚫 Stop Using @Transactional Everywhere: Understand When You Actually Need It
🚫 Stop Writing Fat Controllers: Follow the Controller-Service-Repository Pattern
🚫 Stop Using Field Injection in Spring Boot: Use Constructor Injection
🚫 Stop Sharing Databases Between Microservices: Use Database Per Service Pattern
10 Java Microservices Best Practices Every Developer Should Follow
How to Choose the Right Java Microservices Communication Style (Sync vs Async)
How to Implement Event-Driven Communication in Java Microservices (Step-by-Step Guide with Kafka)
Stop Building Tight-Coupled Microservices: Aim for Loose Coupling
Spring Boot Microservices E-Commerce Project: Step-by-Step Guide
Spring Boot Microservices with RabbitMQ Example
React JS + Spring Boot Microservices
The Ultimate Microservices Roadmap for Beginners: Building Modern Scalable Systems
What Are Microservices in Spring Boot?
Top 5 Message Brokers Every Developer Should Know
Top 10 Spring Cloud Microservices Best Practices [Removed Deprecated Features]
Best Tools for Microservices Development in 2025
How to Break a Monolithic Application into Microservices (E-Commerce Use Case)
Monoliths Aren’t Dead — Microservices Are Just Overused
When to Break a Monolith: A Developer’s Checklist
👑 Java Is Still the King of Microservices — And Here’s the Proof
5 Microservices Design Patterns You Must Know in 2025
Bulkhead Pattern in Microservices — Improve Resilience and Fault Isolation
Strangler Fig Pattern in Microservices — Migrate Monolith to Microservices
Event Sourcing Pattern in Microservices (With Real-World Example)
Circuit Breaker Pattern in Microservices using Spring Boot 3, WebClient and Resilience4j
CQRS Pattern in Microservices
Aggregator Design Pattern in Microservices — A Complete Guide
Database Per Service Pattern in Microservices
API Gateway Pattern in Microservices — A Complete Guide
Saga Pattern in Microservices: A Step-by-Step Guide
Microservices Are a Mess Without These Java Design Patterns️
Java Microservices Interview Questions and Answers for Freshers
Top Microservices Interview Questions and Answers for Experienced Professionals
Top 10 Microservices Design Pattern Interview Questions and Answers
Top Microservices Tricky Interview Questions You Should Know (With Answers)
Microservices Best Practices: Building Scalable and Resilient Systems
Why Microservices Are the Future of Software Architecture
Microservices with Spring Cloud: Simplify Your Architecture
Spring Boot and Microservices Roadmap for Beginners [2025 Update]
Best Programming Language for Microservices Project Development in 2025
My 50+ Must-Read Microservices Tutorials, Articles and Guides on the Medium Platform
Comments
Post a Comment
Leave Comment