REST API error return, include HTTP status code or not

Question

I'm working on an restful API back end, and we only use json as content type. And There are two ways of performing error response as I know:

HTTP status code is always 200, and the returning json should contain error code and error message.
Treat HTTP status code as part of our API, we may pick HTTP error code(4XX) to corresponding error condition. And we can include a json document in the payload to includes a sub-code and a descriptive comment.

I want to know which one is more idiom for a restful service?

place your code, which technique or library are you using for server communivation?.t — Gaurav
– Gaurav, Commented Jul 10, 2015 at 5:30

mansilladev · Accepted Answer · 2015-07-11 00:38:53Z

2

Generally speaking, I would not advocate for always returning a 200. There are failure scenarios that match commonly accepted status codes. Above, someone mentioned 403, which you deliver when access is denied. And 500 is typically issued by the web/app server when things really go south. And 404 if either a record is not found for a resource.

So, I do advocate for:

Going with at least 200, 403, 404, 500
Providing as verbose error details as possible in your JSON error response
Documenting every error code your API might deliver - HTTP status codes and every sub-condition error

answered Jul 11, 2015 at 0:38

mansilladev

9888 silver badges16 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

xyz · Accepted Answer · 2015-07-10 05:55:13Z

2

You need to use both.

HTTP Status: Use this to process the status of the request. For example, if you query a DB and you find no entries, you'll still return 200. If the user is not authorized, 403, if number of SQL connections exceed, 500, and so on.
API Status: If the DB request succeed and you find no entries, include a custom field in your json {status: NO_ENTRIES } or { status: DEPRECATED_API }. In these cases, the response code will still be 200.

answered Jul 10, 2015 at 5:55

xyz

3,4191 gold badge26 silver badges29 bronze badges

2 Comments

realli Over a year ago

And what about always return HTTP status of 200, but use API status to represent corresponding error? I see many company do that.

xyz Over a year ago

I gave you an example for that. If your server encounters a sever error, say out of memory, or the above, you should throw 500, Ann in the json reply, you can still add an error message, telling the client something.

Collectives™ on Stack Overflow

REST API error return, include HTTP status code or not

2 Answers 2

Comments

2 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Related