Набор включает в себя:
- RestControllerAdvice Bean для обработки часто встречающихся исключений
- Исключение для формрование ответов API с определенныи статусом
- Набор аннотаций для Swagger | OpenAPI, описывающие основные варианты HTTP ответов
Добавить в проект зависимость:
<dependency>
<groupId>pro.nikolaev</groupId>
<artifactId>rest-utils</artifactId>
<version>1.0.0</version>
</dependency>
После чего обработка исключений с использованием RestControllerAdvice включается добавлением аннотации
@EnableRestExceptionHandler
к любому классу конфигурации или основному классу приложения:
@EnableRestExceptionHandler
@SpringBootApplication
public class RestUtilsApplication {
public static void main(String[] args) {
SpringApplication.run(RestUtilsApplication.class, args);
}
}
Стандартное тело ответа с сообщением об ошибке будет иметь вид:
{
"message": "Сообщение об ошибке",
"details": "Детали ошибки, если присутствуют"
}