https://github.com/kotlincraft/rest-api-error-handling

Error Handling Best Practices in Spring Boot with Kotlin
https://github.com/kotlincraft/rest-api-error-handling

Last synced: 11 days ago
JSON representation

Error Handling Best Practices in Spring Boot with Kotlin

• Host: GitHub
• URL: https://github.com/kotlincraft/rest-api-error-handling
• Owner: KotlinCraft
• Created: 2024-12-31T11:43:18.000Z (20 days ago)
• Default Branch: main
• Last Pushed: 2024-12-31T12:10:16.000Z (20 days ago)
• Last Synced: 2025-01-01T09:10:48.931Z (20 days ago)
• Language: Kotlin
• Homepage: https://kotlincraft.dev/articles/error-handling-best-practices-in-spring-boot-with-kotlin
• Size: 47.9 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
This document is the example project for the following blog post: [Error Handling Best Practices in Spring Boot with Kotlin](https://kotlincraft.dev/articles/error-handling-best-practices-in-spring-boot-with-kotlin).

# Error Handling Best Practices in Spring Boot with Kotlin

## Overview

This project is a Kotlin-based application that showcases error handling in Spring Boot with Kotlin

The Example API provides endpoints for managing users. It allows you to:  

Retrieve a user by their ID.

Create a new user, with validation to ensure the name is not blank and to prevent duplicate user names.

The API also includes comprehensive error handling to return appropriate HTTP status codes and error messages for various scenarios, such as resource not found, validation failures, and duplicate resources.

## Building the Project

To build the project, you need to have Gradle installed. You can build the project using the following command:

```sh

./gradlew build

```

## Running the Tests

To run the tests, use the following command:

```sh

./gradlew test

```

## File Overview

### `User.kt`

Defines a data class `User` with properties `id` and `name`.

### `UserService.kt`

Contains the `UserService` class with methods to find a user by ID and create a new user. It throws an exception if a user with the name "Alice" already exists.

### `CreateUserRequest.kt`

Defines a data class `CreateUserRequest` with a single property `name`, which must not be blank.

### `BusinessExceptionHandler.kt`

Handles specific business exceptions like `ResourceNotFoundException` and `DuplicateResourceException`, returning appropriate HTTP status codes and error messages.

### `exceptions.kt`

Defines custom exceptions for resource not found, duplicate resource, and invalid operation scenarios.

### `GlobalExceptionHandler.kt`

Handles general exceptions and validation errors, returning appropriate HTTP status codes and error messages.

### `ApiError.kt`

Defines a data class `ApiError` to structure error responses with properties like status, message, errors, timestamp, and path.

### `UserController.kt`

Defines a REST controller with endpoints to get a user by ID and create a new user. It uses `UserService` and handles exceptions for resource not found and duplicate resource scenarios.

### `ErrorHandlingTest.kt`

Contains test cases for the error handling in the application, including scenarios for resource not found, validation failure, and duplicate resource conflict.

## License

This project is licensed under the MIT License.