v3.0.0 - Major Release: Pure Java, RFC 9457 & Enhanced Exception Handling

[PasinduOG]

We are thrilled to announce the release of API Response v3.0.0! 🎉

This is a major milestone that completely removes all external dependencies, upgrades our error handling to the latest industry standards, and makes the library incredibly lightweight and robust.

🚨 IMPORTANT: This is a MAJOR release with BREAKING CHANGES. Please read the migration notes below before upgrading from v2.0.0 or v1.3.0.

⚠️ Breaking Changes

1. ❌ Lombok Dependency Removed: The library is now 100% Pure Java. We have moved away from Lombok's @Builder to a custom builder pattern implementation. This eliminates annotation processing overhead and potential IDE plugin conflicts.
2. ❌ traceId Removed from Success Responses: To keep success payloads clean, traceId is no longer included in standard ApiResponse JSON bodies. Trace IDs are now exclusively injected into error responses (ProblemDetail) for debugging. (You can still use MDC/Headers for success tracing).

✨ New Features

• 🛡️ 10 Comprehensive Exception Handlers: We've expanded the GlobalExceptionHandler to automatically cover 6 new critical scenarios (Total 10):

• HttpMessageNotReadableException (Malformed JSON)

• MissingServletRequestParameterException (Missing Params)

• NoResourceFoundException (404 Not Found)

• HttpRequestMethodNotSupportedException (405 Method Not Allowed)

• HttpMediaTypeNotSupportedException (415 Unsupported Media Type)

• NullPointerException (with safe stack trace logging)

• 📋 RFC 9457 Compliance: Upgraded error formatting from RFC 7807 to the latest RFC 9457 ProblemDetail standard.

• 🔍 Distributed Tracing Filter: Added TraceIdFilter for automatic trace ID generation, MDC integration, and seamless log correlation across microservices.

• 📚 100% Javadoc Coverage: Achieved a perfectly clean build with zero Javadoc warnings. Every class, method, and constructor is now explicitly documented.

🛠️ Improvements

• Zero External Dependencies: Only requires spring-boot-starter-web (provided scope). No more transitive dependency worries!
• Thread-Safe by Design: Fully immutable response objects with a minimal memory footprint (~200 bytes per response).
• Spring Boot 4.0.2 Ready: Fully tested and verified compatibility with Spring Boot 3.2.0 through 4.0.2.

---

🔄 Quick Migration Guide (v2.0.0 ➡️ v3.0.0)

If you were using the static factory methods (success(), created(), status()), no code changes are required!

If you were manually building responses using the builder, update your syntax:

❌ Before (v2.0.0):

ApiResponse<User> response = ApiResponse.<User>builder()
    .message("Success")
    .data(user)
    .build();

✅ After (v3.0.0):

ApiResponse<User> response = new ApiResponse.ApiResponseBuilder<User>()
    .message("Success")
    .content(user) // Note: "data" was renamed to "content"
    .build();

---

📦 Installation

Maven:

<dependency>
    <groupId>io.github.pasinduog</groupId>
    <artifactId>api-response</artifactId>
    <version>3.0.0</version>
</dependency>

Gradle:

implementation 'io.github.pasinduog:api-response:3.0.0'

What's Changed

• Feature/v3.0.0 by @PasinduOG in Feature/v3.0.0 #13
• Dev by @PasinduOG in Dev #14

Full Changelog: v2.0.0...v3.0.0

---

This discussion was created from the release v3.0.0 - Major Release: Pure Java, RFC 9457 & Enhanced Exception Handling.