search

Haufe-Lexware / api-style-guide

Haufe API Style Guide
https://haufe-lexware.gitbooks.io/haufe-api-styleguide/content/
Apache License 2.0
233 stars 79 forks source link

Propose RFC 7807 as an alternative error response format #36

Closed chludwig-haufe closed 7 years ago

chludwig-haufe commented 7 years ago

While reviewing the Aurora Mobile API, I realized that our style guide does not mention RFC 7807 at all. RFC 7807 - published in March 2016 - specifies extendable JSON and XML formats for "problem reports" (i.e., error responses).

Both specs - vnd.error and RFC 7807 - serve the purpose at hand, I think. Given that RFC 7807 explicitly describes both JSON and XML formats and that it went through a formal review process, I prefer RFC 7807. That said, I saw no strong reason to "purge" all references to vnd.error.

hlgr360 commented 7 years ago

@chludwig-haufe - Can you please open an issue in the issue tracker for us to re-evaluate the appropriate error response format in some TBD interval to see if we can settle on one vs the other? It sounds like the RFC 7808 has a more normative meaning than vnd.error