NK

Support Ukraine

REST and JSON Best Practices

REST is an architecture style that has been poorly understood for a long time. Nowadays there are lots of excellent style guides. Below I've gathered some guidelines and best practices from various sources.

HTTP methods #

HTTP result codes #

The following list contains the more relevant REST-service HTTP status codes. A common mistake is to return a 200 OK when something went wrong; REST services ought to utilize what HTTP has on offer.

URL format #

Response body #

JSON/REST API documentation (*) #

Some sources I've bookmarked on these subjects subjects:

← Home