The following is a guest post by AddThis VP of Engineering, Charlie Reverte, posted today at APIUX.com. To read the rest of the blog post, click here to go over to their site.
URL design discussions for RESTful web services often degrade into debates over pluralization and parameter names. There are a couple of principles I like to use to keep things simple.
1) Using your API should feel like using a filesystem
- Endpoints used to create, list, and search for entities should look like directories, e.g.
- Use a plural noun so it feels like a directory of users, not a user controller
- Endpoints used to read, update, and delete individual entities should look like files, e.g.
2) All calls to a given endpoint should return the same type
- Either apples, or oranges, or a list of oranges, don’t mix them up
- File-looking endpoints should return individual entities
- Directory-looking endpoints should return lists of entities
We may be bikeshedding here but I think your API will be more intuitive to newcomers if you model it this way.
- Consistent response type per endpoint simplifies deserialization for clients, no switching needed
- Once you agree on a contract it’s easy to mock up with static files on a server
- Clients can start working with your mockup before your code is finished
To read the rest of this blog post, head over to APIUX.