https://github.com/ekino/spring-boot-starter-errors

Opiniated Spring Boot starter that handles common exceptions and returns them in a standardize json format
https://github.com/ekino/spring-boot-starter-errors

error-handling exception-handling kotlin spring-boot starter

Last synced: 2 days ago
JSON representation

Opiniated Spring Boot starter that handles common exceptions and returns them in a standardize json format

• Host: GitHub
• URL: https://github.com/ekino/spring-boot-starter-errors
• Owner: ekino
• License: mit
• Created: 2019-07-17T12:07:34.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-03-29T01:45:39.000Z (8 months ago)
• Last Synced: 2024-04-14T12:51:00.129Z (7 months ago)
• Topics: error-handling, exception-handling, kotlin, spring-boot, starter
• Language: Kotlin
• Homepage:
• Size: 772 KB
• Stars: 9
• Watchers: 16
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Spring Boot starter errors

[![GitHub (pre-)release](https://img.shields.io/github/release/ekino/spring-boot-starter-errors/all.svg)](https://github.com/ekino/spring-boot-starter-errors/releases)

[![Maven Central](https://img.shields.io/maven-central/v/com.ekino.oss.spring/ekino-spring-boot-starter-errors)](https://search.maven.org/search?q=a:ekino-spring-boot-starter-errors)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ekino_spring-boot-starter-errors&metric=alert_status)](https://sonarcloud.io/dashboard?id=ekino_spring-boot-starter-errors)

Opinionated Spring Boot starter that handles some Spring and AWS common exceptions and returns them in standardize json format.

## Requirements

This starter requires Java 17 and is compatible up to and including Java 19.

It also requires a Spring Boot **MVC** web application.

### Spring Boot compatibility

| Spring Boot | starter-errors | Kotlin |

|:-----------:|:--------------:|:------:|

|     3.0     |      9.x       |  1.7   |

|     2.7     |      8.x       |  1.7   |

|     2.6     |      7.x       |  1.6   |

|     2.5     |      5.x       |  1.5   |

|     2.4     |      4.x       |  1.4   |

Other combinations might work, but they're not supported.

## Usage

For example with Gradle Kotlin DSL :

```kotlin

implementation("com.ekino.oss.spring:ekino-spring-boot-starter-errors:8.0.0")

```

NB : if you want to use snapshots you need to add the following configuration to your Gradle build script :

```kotlin

repositories {

  maven { url = uri("https://oss.sonatype.org/content/repositories/snapshots/") }

}

```

## Configuration

Default configuration is production-ready.

Anyway, if you want your json to contain the full stacktrace you have to add the following configuration :

```yaml

ekino:

  errors:

    display-full-stacktrace: true # false by default

```

We recommend you to enable stacktraces only for local or any other development environment.

## Examples

### Bean validation error

```json

{

  "status": 400,

  "code": "error.invalid",

  "message": "Bad Request",

  "description": "Validation failed",

  "errors": [

    {

      "code": "error.missing.company",

      "field": "company",

      "message": "must not be null"

    }

  ],

  "globalErrors": [],

  "service": "my-api : POST /api/customers",

  "stacktrace": "",

  "timestamp": "2019-12-12T16:11:27.262Z"

}

```

### Spring security disabled account

```json

{

  "status": 403,

  "code": "error.disabled_account",

  "message": "Forbidden",

  "description": "User is disabled",

  "errors": [],

  "globalErrors": [],

  "service": "my-api : POST /api/auth",

  "stacktrace": "",

  "timestamp": "2019-12-12T16:11:27.262Z"

}

```