Skip to content

README.md

Latest commit

 

History

History
68 lines (48 loc) · 3.3 KB

README.md

File metadata and controls

68 lines (48 loc) · 3.3 KB
Raw

Versioning REST API with Spring Boot and Swagger Twitter

CircleCI

SonarCloud Bugs Coverage Lines of Code

Articles

  1. Guide to API versiong with Spring Boot and a standard API offered by Spring MVC before official built-in support was available. Detailed description can be found here: Versioning REST API with Spring Boot and Swagger
  2. Guide to built-in API versioning feature available since Spring Boot 4. Detailed description can be found here: Spring Boot Built-in API Versioning

API Versioning Implementation

This project demonstrates API versioning using Spring Boot 4's built-in support with the following features:

Versioning Strategies

  1. URL Path Versioning (Primary method used)

    • Example: /persons/v1.0/1
    • Configured in application.yml with path-segment: 1

  2. Header-based Versioning (Alternative method)

    • Header: X-VERSION: v1.0
    • Configured in application.yml

Versioned Models

  1. PersonOld (v1.0+)

    • Fields: id, name, gender, birthDate (LocalDate)
    • Used by default for v1.0 and v1.1

  2. PersonCurrent (v1.2+)

    • Fields: id, name, gender, age (int)
    • Introduced in v1.2

Available Endpoints

Create Person

  • POST /persons/v1.0+ - Create person with birthDate (v1.0, v1.1)
  • POST /persons/v1.2 - Create person with age (v1.2)

Update Person

  • PUT /persons/v1.0 - Update person (deprecated in v1.0)
  • PUT /persons/v1.1/{id} - Update person (v1.1)
  • PUT /persons/v1.2/{id} - Update person (v1.2)

Get Person

  • GET /persons/v1.0/{id} - Get person with birthDate (v1.0, v1.1)
  • GET /persons/v1.2/{id} - Get person with age (v1.2)

Delete Person

  • DELETE /persons/v1.0/{id} - Delete person (v1.0+)

Configuration

The versioning is configured in application.yml:

spring:
  mvc:
    apiversion:
      default: v1.0
      use:
        header: X-VERSION
        path-segment: 1