Search results
Use HTTP Status + json body (even if it is an error). Define a uniform structure for errors (ex: code, message, reason, type, etc) and use it for errors, if it is a success then just return the expected json response.
29 mar 2024 · In this blog post, we’ll explore the intricacies of API response JSON format, often referred to as the lingua franca of the web. We’ll uncover why developers favor it, how it streamlines the process of data interchange, and the best practices for structuring JSON responses.
This document defines a "problem detail" to carry machine-readable details of errors in HTTP response content to avoid the need to define new error response formats for HTTP APIs. This document obsoletes RFC 7807.
This specification defines simple JSON [RFC7159] and XML [W3C.REC-xml-20081126] document formats to suit this purpose. They are designed to be reused by HTTP APIs, which can identify distinct "problem types" specific to their needs.
6 gru 2012 · In a "RESTful" approach, the primary error response is indicated by an appropriate status code (4xx/5xx). Your message should provide addtional, application-specific hints on how to recover from the error.
16 sty 2020 · As you can see, the preferred format of the response is JSON. According to the RFC, the standard parts that make up the error response model are type , title , status , detail and instance . Let’s look at the various fields within the model to see what they are intended for.
For an issue with a malformed request body property, we can leverage the errors extension to provide explicit information on the issue as well as the property location via the details and pointer (which specifies a JSON Pointer to the location of the property) properties.
