Design Your REST API So That It Will Get Used
by Jay Kapadnis, Tempus Architect
Poorly Designed REST APIs = FRUSTRATION
Working as a Tempus developer and architect, I integrate with plenty of services through REST. Sometimes I find it difficult and time consuming to integrate/consume APIs due to poor design with little to no documentation. This leads to developers (and me) abandoning existing services, and possibly duplicating functionality. To avoid this frustration, the engineering team at Hashmap strives to adhere to specific standards and specifications laid out by existing REST standards.
Let?s start our discussion by first understanding what REST is and what is meant by designing REST APIs.
What is REST?
In 2000, Roy Fielding, one of the principal authors of the HTTP specification, proposed an architectural approach for designing web-services known as Representational State Transfer (REST).
Note that, while this article assumes REST implementation with HTTP protocol, REST is not tied to HTTP. REST API?s are implemented for a ?resource? which could be an entity or service. These API?s provide way to identify a resource by its URI, which can be used to transfer a representation of a resource?s current state over HTTP.
Why Is API Design So Important?
People ask this question quite a lot, and to answer this:
REST APIs are the face of any service, and therefore they should:
1. Be easy to understand so that integration is straightforward
2. Be well documented, so that semantic behaviors are understood (not just syntactic)
3. Follow accepted standards such as HTTP
Designing and Developing Highly Useful REST APIs
There are several conventions we follow at Hashmap while designing our REST APIs, so that we ensure we meet the expectations listed above for our accelerator development and our consulting engagements.
These conventions are as follows:
1. Use Nouns in URI
REST API?s should be designed for Resources, which can be entities or services, etc., therefore they must always be nouns. For example, instead of /createUser use /users
2. Plurals or Singulars
Generally, we prefer to use plurals but there is no hard rule that one can?t use singular for resource name. The ideology behind using plurals is:
We are operating on one resource from collection of resources so to depict collection we use plural
For example, in the case of?
the client is asking to retrieve a resource from users collection with id 123. While creating a resource we want to add one resource to current collection of resources, so the API looks like the below?
3. Let the HTTP Verb Define Action
As per point #1 above, API?s should only provide nouns for resources and let the HTTP verbs (GET, POST, PUT, DELETE) define the action to be performed on a resource.
The table below summarizes use of HTTP verbs along with APIs:
Table 1: HTTP Verbs and Use
4. Don?t Misuse Safe Methods (Idempotency)
Safe methods are HTTP methods which return the same resource representation irrespective of how many times are called by client. GET, HEAD, OPTIONS and TRACE methods are defined as safe, meaning they are only intended for retrieving data and should not change a state of a resource on a server. Don?t use GET to delete content, for example?
It?s not like this can?t be implemented, but HTTP specification is violated in this case.
Use HTTP methods according to the action which needs to be performed.
5. Depict Resource Hierarchy Through URI
If a resource contains sub-resources, make sure to depict this in the API to make it more explicit. For example, if a user has posts and we want to retrieve a specific post by user, API can be defined as GET /users/123/posts/1 which will retrieve Post with id 1 by user with id 123
6. Version Your APIs
Versioning APIs always helps to ensure backward compatibility of a service while adding new features or updating existing functionality for new clients. There are different schools of thought to version your API, but most of them fall under two categories below:
There are 2 ways you can specify version in headers:
Adding a custom X-API-VERSION (or any other header of choice) header key by client can be used by a service to route a request to the correct endpoint
Using accept header to specify your version such as
=> Accept: application/vnd.hashmapinc.v2+json
Embed the version in the URL such as
We prefer to use URL method for versioning as it gives better discoverability of a resource by looking at the URL. Some may argue URL refers to the same resource irrespective of version and since response representation may or may not change after versioning, what?s the point of having a different URL for the same resource?
I am not advocating for one approach over another here, and ultimately, the developer must choose their preferred way of maintaining versions.
7. Return Representation
POST, PUT or PATCH methods, used to create a resource or update fields in a resource, should always return updated resource representation as a response with appropriate status code as described in further points.
POST if successful to add new resource should return HTTP status code 201 along with URI of newly created resource in Location header (as per HTTP specification)
8. Filter, Search and Sort
Don?t create different URIs for fetching resources with filtering, searching, or sorting parameters. Try to keep the URI simple, and add query parameters to depict parameters or criteria to fetch a resource (single type of resource)
Use query parameters defined in URL for filtering a resource from server. For example, if we would like to fetch all published posts by user you can design an API such as:
In the example above, state is the filter parameter
To get the results with powerful search queries instead of basic filters, one could use multiple parameters in a URI to request to fetch a resource from server.
The above query searches for posts which are published with the Scala tag. It?s very common today for Solr to be used as search tool as it provides advanced capabilities to search for a document and you can design your API such as:
This will search posts for free text ?sometext?(q) and filter results on fq state as published and having tag Scala.
ASC and DESC sorting parameters can be passed in URL such as:
Returns posts sorted with descending order of update date time.
Hypermedia As Transfer Engine Of Application State is a constraint of the REST application architecture that distinguishes it from other network application architectures.
It provides ease of navigation through a resource and its available actions. This way a client doesn?t need to know how to interact with an application for different actions, as all the metadata will be embedded in responses from the server.
To understand it better let?s look at the below response of retrieve user with id 123 from the server:
?name?: ?John Doe?,
Sometimes it?s easier to skip the links format, and specify links as fields of a resource as below:
?name?: ?John Doe?,
It?s not a convention you need to follow every time, as it depends on resource fields/size, and actions which can be performed on resource. If resources contain several fields that the user may not want to go through, it?s a good idea to show navigation to sub-resources then implement HATEOAS.
10. Stateless Authentication & Authorization
REST APIs should be stateless. Every request should be self-sufficient and must be fulfilled without knowledge of the prior request. This happens in the case of Authorizing a user action.
Previously, developers stored user information in server-side sessions, which is not a scalable approach. For that reason, every request should contain all the information of a user (if it?s a secure API), instead of relying on previous requests.
This doesn?t limit APIs to a user as an authorized person, as it allows service-to-service authorization as well. For user authorization, JWT (JSON Web Token) with OAuth2 provides a way to achieve this. Additionally, for service-to-service communication, try to have the encrypted API-key passed in the header.
11. Swagger for Documentation
Swagger is a widely-used tool to document REST APIs that provides a way to explore the use of a specific API, therefore allowing developers to understand the underlying semantic behavior. It?s a declarative way of adding documentation using annotations which further generates a JSON describing APIs and their usage.
We have created a Maven Archetype which can get you started here: Maven Archetype.
12. HTTP Status Codes
Use HTTP status codes to provide the response to a client. It could be a success or failure response, but it should define what the respective success or failure means from a server perspective.
Below are the categories of responses by their status codes:
200 OK: Returned by a successful GET or DELETE operation. PUT or POST can also use this, if the service does not want to return a resource back to the client after creation or modification.
201 Created: Response for a successful resource creation by a POST request.
304 Not Modified: Used if HTTP caching header is implemented.
4xx Client Errors
400 Bad Request: When an HTTP request body can?t be parsed. For example, if an API is expecting a body in a JSON format for a POST request, but the body of the request is malformed.
401 Unauthorized: Authentication is unsuccessful (or credentials have not been provided) while accessing the API.
403 Forbidden: If a user is not Authorized to perform an action although authentication information is correct.
404 Not Found: If the requested resource is not available on the server.
405 Method Not Allowed: If the user is trying to violate an API contract, for example, trying to update a resource by using a POST method.
5xx Server Errors
These errors occur due to server failures or issues with the underlying infrastructure.
Developers need to spend some time while designing REST APIs, as the API can make a service very easy to use or extremely complex. Additionally, the maturity of the APIs can be easily documented by using the Richardson Maturity Model.
If you?d like to share your thoughts on integrating with REST services and understand more about what I?m working on daily with Tempus or to schedule a demonstration, please reach out to me at firstname.lastname@example.org.
Feel free to share across other channels and be sure and keep up with all new content from Hashmap at https://medium.com/hashmapinc.
Jay Kapadnis is a Tempus Architect at Hashmap working on the engineering team across industries with a group of innovative technologists and domain experts accelerating high value business outcomes for our customers.