guide2 min read

API Design Guide

Design APIs that developers love: naming, versioning, errors, and pagination.

API design principles: use nouns for resources (/users not /getUsers), plural names (/users/1 not /user/1), version in URL (/api/v1/users), consistent error format ({ error: { code, message, details } }), cursor pagination for large datasets (not offset), HATEOAS links for discoverability, rate limiting with clear headers, and comprehensive OpenAPI/Swagger docs. The best APIs feel obvious to use without reading documentation.