Skip to content

pramodkuth/springboot-openapi-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

3 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Spring Boot + OpenAPI Template

A clean, versioned Spring Boot template for building RESTful APIs with Swagger (Springdoc OpenAPI), grouped documentation, and custom headers β€” perfect for microservices or API-first projects.


πŸš€ Features

  • βœ… Spring Boot 3.x
  • βœ… OpenAPI 3.1 with Springdoc
  • βœ… API versioning (/v1, /v2) via GroupedOpenApi
  • βœ… Custom headers (e.g. X-B3-Span-Id) documented in Swagger
  • βœ… Shared metadata (contact, license, etc.) across versions

πŸ“š API Documentation


πŸ“¦ Getting Started

Prerequisites

  • Java 17+
  • Maven 3.8+

Run the App

./mvnw clean
./mvnw spring-boot:run

About

Spring Boot OpenAPI Swagger 3 sample with versioned and grouped REST APIs

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages