Skip to content

Latest commit

 

History

History
81 lines (55 loc) · 2.26 KB

Readme.md

File metadata and controls

81 lines (55 loc) · 2.26 KB
Raw

Exception Spring 🚀

License: MIT Java Spring Boot

Exception Spring is a library offering pre-configurations for exception handling in Spring Boot applications. It leverages the RFC-9457 Problem Detail Specification to ensure standardized and robust error responses in your APIs.

✨ Features

  • ✅ Pre-configured exception handling for common use cases.
  • ✅ Fully compliant with Problem Detail standards.
  • ✅ Easily customizable for your specific requirements.
  • ✅ Compatible with Spring Boot 3+.

📚 Documentation

Detailed documentation is available on the GitHub Pages site.

⚠️ Note: The documentation is a work in progress and may not yet cover all use cases. Contributions and feedback are appreciated!

🚀 Quick Start

Maven

<dependency>
    <groupId>com.example</groupId>
    <artifactId>exception-spring</artifactId>
    <version>1.0.0</version>
</dependency>

Gradle

implementation 'com.example:exception-spring:1.0.0'

Activation **

Annotate your main application class with:

@EnableExceptionSpring

🤝 Contributing

We welcome contributions! But currently the repo is in its initial stages! Stay tuned for updates

🛡️ License

This project is licensed under 🤔🤔 am still unsure about that.

📫 Stay in Touch

Feel free to open an issue or reach out to us via GitHub Discussions! Follow @dineshrn751 on for updates.

Highlights of this Version:

Docs

  • Added badges for license, Java version, and Spring Boot compatibility.
  • Used emoji icons to enhance readability and visual appeal.
  • Organized sections with clear headings and separators.

Library

  • Support for Spring Boot Servlet projects.
  • Bunch of pre-configured exceptions, with ProblemDetail response.
  • Interface for Implementing Custom handlers for new exceptions.
  • More planned in pipeline 💃🕺

** indicates still in implementation