rest-api-design
SolidComprehensive, technology-agnostic principles and best practices for designing REST APIs. Use this skill whenever designing new REST endpoints, reviewing API contracts, planning versioning strategy, defining error formats, or establishing API standards for a project. Also trigger when discussing backward compatibility, API security, pagination, rate limiting, authentication schemes, or OpenAPI spec authoring — even if the user doesn't say "REST API" explicitly. This skill is the authoritative guide for all API design decisions.
Install
Quality Score: 78/100
Skill Content
Details
- Author
- virajp
- Repository
- virajp/ai-plugins
- Created
- 2 months ago
- Last Updated
- yesterday
- Language
- JavaScript
- License
- MIT
Integrates with
Similar Skills
Semantically similar based on skill content — not just same category
designing-rest-apis
Guides designing, reviewing, and governing RESTful APIs — resource modeling, URL structure, HTTP methods, status codes, error handling (RFC 9457), pagination, versioning, security, authentication, caching, idempotency, bulk operations, async patterns, file uploads, OpenAPI documentation, API-first process, and AI-agent consumers. Use when designing new REST API endpoints, reviewing existing API designs, adopting API-first development, running API design sessions, enforcing API contracts in CI/CD, governing an API program, choosing between REST patterns (cursor vs offset pagination, PUT vs PATCH, polling vs webhooks), writing OpenAPI specs, designing for AI-agent consumers (MCP), or making API evolution and deprecation decisions.
rest-api-design
Conventions for designing clean, consistent, evolvable REST APIs — resource modeling, HTTP semantics, status codes, pagination, filtering, error envelopes, versioning, idempotency, and security. A deep reference with worked examples and runnable checks.
design-api
Design RESTful and GraphQL APIs following current best practices for naming, versioning, error shapes, and auth patterns. Use when the user says "design an API", "create endpoints", "structure my API responses", "plan API architecture", "REST vs GraphQL", or "API contract". Covers OpenAPI spec, pagination, rate limiting, and backwards-compatible evolution. Pairs with backend-patterns, audit-security.