api-design
REST API design patterns covering resource naming, HTTP semantics, pagination, filtering, error handling, and versioning.
- Resource URLs use plural nouns in kebab-case with semantic HTTP methods; status codes (201, 204, 400, 404, 422, 429) convey intent rather than embedding status in response bodies
- Supports offset-based pagination for small datasets and cursor-based pagination for scalable, feed-like interfaces; includes filtering via query parameters, sorting, and sparse fieldsets
- Error responses include structured codes, messages, and field-level details; success responses wrap data in consistent envelopes with optional metadata and pagination links
- Covers token and API key authentication, resource-level and role-based authorization patterns, and rate limiting with tier-based quotas and Retry-After headers
- Recommends URL path versioning (/api/v1/) with deprecation timelines; distinguishes breaking changes (new version required) from non-breaking additions (no version bump needed)
API Design Patterns
Conventions and best practices for designing consistent, developer-friendly REST APIs.
When to Activate
- Designing new API endpoints
- Reviewing existing API contracts
- Adding pagination, filtering, or sorting
- Implementing error handling for APIs
- Planning API versioning strategy
- Building public or partner-facing APIs
Resource Design
URL Structure
# Resources are nouns, plural, lowercase, kebab-case
More from affaan-m/everything-claude-code
security-review
Use this skill when adding authentication, handling user input, working with secrets, creating API endpoints, or implementing payment/sensitive features. Provides comprehensive security checklist and patterns.
7.9Kgolang-patterns
Idiomatic Go patterns, best practices, and conventions for building robust, efficient, and maintainable Go applications.
7.4Kcoding-standards
Baseline cross-project coding conventions for naming, readability, immutability, and code-quality review. Use detailed frontend or backend skills for framework-specific patterns.
6.7Kfrontend-patterns
Frontend development patterns for React, Next.js, state management, performance optimization, and UI best practices.
6.6Kbackend-patterns
Backend architecture patterns, API design, database optimization, and server-side best practices for Node.js, Express, and Next.js API routes.
6.6Kgolang-testing
Go testing patterns including table-driven tests, subtests, benchmarks, fuzzing, and test coverage. Follows TDD methodology with idiomatic Go practices.
6.1K