Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[PROPOSAL] Add a section on a formalize error details in HTTP response (following RFC7807) #93

Open
dbelyaev opened this issue Mar 22, 2024 · 0 comments

Comments

@dbelyaev
Copy link

Problem:

When error happens in API processing developer need to return a code to the user and also some additional information, if possible.

Initially, RFC 7807 has been introduced with the idea to standardize the response for the error reporting from server to client (json and predefined fields, that can be extended).

Before the RFC 7807 started to be wide-spread, Zalando open-sourced their Java library Problem that implemented this standard and supporting classes -- and this was quite popular and adopted quickly.

Nowadays, adoption of the RFC 7807 is a common practice (for example, in Java world: Spring framework implements it via ProblemDetail class which can be used as response on controllers).

Proposal:

Could be a good idea to reference to the RFC 7807 somewhere in the Equinor REST guideline.

@dbelyaev dbelyaev changed the title [PROPOSAL] Add a section on a readable details of errors in HTTP response (following RFC7807) [PROPOSAL] Add a section on a formalize error details in HTTP response (following RFC7807) Mar 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant