Rest APIs are REST-in-Peace APIs. Long Live GraphQL.

Rest APIs are REST-in-Peace APIs. Long Live GraphQL.” is yet another look at REST vs. GraphQL for the API implementation.

I’m involved with developing quite a bit of REST APIs at work, but for now we are just trying to buy us some time.  I want to take a really long and good look at GraphQL, but I don’t think this will happen this year.  In the meantime, if you have any good GraphQL resources, please do send them my way.

OpenAPI Specification

OpenAPI Specification v2.0 – formerly known as Swagger RESTful API Documentation Specification.

Swagger™ is a project used to describe and document RESTful APIs.

The Swagger specification defines a set of files required to describe such an API. These files can then be used by the Swagger-UI project to display the API and Swagger-Codegen to generate clients in various languages. Additional utilities can also take advantage of the resulting files, such as testing tools.

Best Practices for Designing a Pragmatic RESTful API

An API is a user interface for developers. Put the effort in to ensure it’s not just functional but pleasant to use.

Vinay Sahni has a rather lengthy, detailed, and well-rounded post on how to design a good RESTful API.  It covers pretty much everything from URL structures and parameters, request methods, to error handling, documentation, and coding style.