Agent skill · software engineering · aiskillstore
api-designer
Design and document RESTful and GraphQL APIs with OpenAPI/Swagger specifications, authentication patterns, versioning strategies, and best practices. Use for: (1) Creating API specifications, (2) Designing REST endpoints, (3) GraphQL schema design, (4) API authentication and authorization, (5) API versioning strategies, (6) Documentation generation
Why this skill is useful
Provides detailed patterns and strategies for API design that the AI wouldn't reliably generate on its own.
What it needs
About 7k tokens when loaded. Last updated 2026-08-07. 405 stars on the source repository.
What this skill does
API Designer Overview This skill provides comprehensive guidance for designing, documenting, and implementing modern APIs. It covers both REST and GraphQL paradigms, with emphasis on industry best practices, clear documentation, and maintainable architecture. Use this skill to create production-ready API designs that are scalable, secure, and developer-friendly. Core Capabilities REST API Design Resource-oriented endpoint design with proper URL structure HTTP method semantics and status code usage Request/response payload design with consistent naming Pagination, filtering, and sorting strategies Error handling and validation patterns GraphQL API Design Schema definition with type system and relationships Query and mutation design with proper input types Resolver patterns and performance optimization Fragment usage and directive implementation N+1 problem prevention strategies API Documentation OpenAPI 3.0 specification generation Interactive documentation with Swagger UI Authentication and authorization documentation Example requests/responses with multiple scenarios Code generation from specifications Authentication & Authorization OAuth 2.0 flows (authorization code, client credentials, PKCE) JWT token design, validation, and rotation API key management and rotation strategies Role-based access control (RBAC) implementation Rate limiting and throttling patterns API Versioning URL versioning and header-based versioning strategies Semantic versioning for API releases Deprecation planning and communication Backward compatibility maintenance Migration path design When to Use This Skill Use this skill when: Designing a new API from scratch or refactoring existing endpoints Creating OpenAPI/Swagger specifications for documentation Implementing authentication and authorization flows Planning API versioning and deprecation strategies Designing GraphQL schemas and resolvers Establishing API governance and best practices REST API Design Workflow Step 1: Identify Resources …
How to use it
Reference it in AdaL, Claude Code, Cursor or any coding agent — nothing to install:
@skills aiskillstore/api-designer