The REST API cookbook

All recipes

When and how to version your API ?

Design asynchronous API

How to design asynchronous API

Batch processing

Update many resources in a single request (a.k.a. a batch)

I need a way to handle calls that contains many parameters in URL

Create a resource with an already known id

How to create a resource when the id is already known?

API Error format

How to format the response body in case of an API error?

Beware of chatty errors

How error messages can lead to security issues ?

File upload through API

How to upload a file through a REST API?

Internationalize your API

How to design API resources that depends on the requested language or country

Light and complex resources

I need a light version and a complete version of the same resource

Partial update of a resource

How to update only a few fields of a resource?

Resource existence

How to check a resource existence ?

Resources depending on an authenticated user

Should I expose resources depending on the user authenticated by an access token?

Self-generated documentation

Why use self-generated documentation for our API ?

Made with ❤️ by the WOAPI team @OCTO.

Repository: Cookbook API (opens new window)