Media Type for errors?

[James Nail]

Has anyone here used a specific media type to return API errors?

If so, which one(s)?

Which would you recommend?

I know about Mark Nottingham's application/problem+json type, but I figured I'd try to get some opinions before just going with that one by default.

Thanks,

James

[Adrien Risser]

I'm using Ben Longden's "application/vnd.error+json" for my current development.

As my preferred hypermedia type is HAL+json, it's a good start.

I've extended it with an explicit "status" property, a misc "data" and a "stack" (only in dev environment).

Spec: https://github.com/blongden/vnd.error.

Cheers,

--
You received this message because you are subscribed to the Google Groups "API Craft" group.
To unsubscribe from this group and stop receiving emails from it, send an email to api-craft+...@googlegroups.com.
Visit this group at https://groups.google.com/group/api-craft.

For more options, visit https://groups.google.com/d/optout.

--

Adrien Risser,

Freelance Node.js Consultant

M. +33 6 59 60 32 58

https://www.linkedin.com/in/adrienrisser

[Alexander Zeitler]

Hi,

 

we’re using application/problem+json.

 

Alex

--

[Pete Johanson]

We're happily using application/problem+json. I particularly appreciate the base core combined with the 'type' property, allowing for both generic handling plus type specific handling as needed.

-pete

--

[James Nail]

Interesting!  I ran across that one earlier in the day, but honestly, since I hadn't heard of it before, I didn't give it serious consideration.

It's interesting that it's HAL-compatible, as it makes a lot of sense to ensure your errors are actionable in a generically programmatic way.

[Przemek Wesołek]

BTW, application/problem+(json|xml) has been promoted to RFC: http://tools.ietf.org/html/rfc7807

Przemek