TechnicalDebt: Implement exception filter

3PillarGlobal-Czechia / interview-app-api

API for Interview App.

MIT License

3 stars 1 forks source link

TechnicalDebt: Implement exception filter #69

Closed PlesnikJakub closed 2 years ago

PlesnikJakub commented 2 years ago

Description

As a consumer of the API, I want to be informed about unexpected errors in a standardized manner.

Acceptance Criteria

If an Exception is thrown

API should respond with HTTP Error 500
Response should be in JSON with the title, description, and stack trace
Title should be generic like = "Server error", "Bad Request"
Description can contain brief error info. (e.g exception message)
Stack trace should be present only on the development environment

PlesnikJakub commented 2 years ago

Official documentation regarding filters: https://docs.microsoft.com/en-us/aspnet/web-api/overview/error-handling/exception-handling

https://github.com/ivanpaulovich/clean-architecture-manga/blob/main/accounts-api/src/WebApi/Modules/Common/ExceptionFilter.cs

PlesnikJakub commented 2 years ago

Additional changes required

The current logging solution uses middleware to log all exceptions. Ensure that the logging of exceptions is still working as expected otherwise contact @PlesnikJakub or @petrspelos with a update proposal.