api-design-patterns

REST API design uses noun-based resource names in plural form (e.g., /users, /orders) with HTTP methods (GET, POST, PUT, DELETE) matching the operation semantics. This Skill covers hierarchical path structures, query-based filtering, appropriate status codes for each operation, and OpenAPI documentation to ensure consistency across endpoints.

API versioning strategies include URL-based (v1, v2) or header-based approaches to manage breaking changes. Pagination uses limit/offset or cursor-based patterns to structure large datasets efficiently. This Skill provides language-agnostic patterns for both, with examples across REST and GraphQL implementations.

GraphQL schema design applies resolver patterns, input types, and mutation structures while integrating authentication schemes and standardized error responses. This Skill covers schema semantics, error handling conventions, and authentication integration across GraphQL resolvers alongside REST equivalents.

Yes. This Skill provides language-agnostic design patterns applicable to both REST endpoints and GraphQL resolvers, covering resource naming, status codes, versioning, pagination, filtering, authentication, and error handling across both architectural styles.

HTTP status codes convey operation outcomes: 200 for success, 201 for resource creation, 400 for client errors, 401/403 for authentication/authorization failures, and 5xx for server errors. This Skill matches status codes to REST methods and operations with semantic accuracy and OpenAPI documentation.

OpenAPI/Swagger specs formally document endpoints, methods, parameters, request/response schemas, status codes, and authentication requirements. This Skill teaches spec creation alongside resource naming, versioning, and pagination patterns to ensure API contracts are clear and enforceable.