API Design

Notes and references on designing APIs — resource modelling, naming, versioning, errors and the conventions that keep an API consistent as it grows.

References

• Google API Improvement Proposals (AIPs) — Google's public collection of API design guidance. Each AIP is a short, numbered document that settles one design question (resource names, standard methods like Get/List/ Create, pagination, filtering, long-running operations, errors), and AIP-100 explains the process itself. Written for Google's own resource-oriented gRPC and REST APIs, but the rules carry over well to any API you want to feel predictable to its callers.