api-design

Design REST and GraphQL APIs with consistent endpoint naming, validation, and error handling.

Updated Mar 27, 2026
One-click install
npx skills add https://github.com/Awais16/skills-vault --skill api-design-awais16
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/Awais16/skills-vault/tree/main/skills/api-design
Command: npx skills add https://github.com/Awais16/skills-vault --skill api-design-awais16

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Designing and maintaining consistent RESTful and GraphQL APIs can be difficult; this guide provides patterns to standardize endpoints, validation, error handling, responses, authentication, pagination, and versioning.

Core Features & Use Cases

  • Standardized endpoint naming (plural nouns, kebab-case) for predictable routes
  • Integrated validation and coherent error responses (schema-based)
  • Authentication, authorization, pagination, and versioning strategies
  • Real-world usage example: designing a /api/products endpoint set with listing, retrieval, creation, and updates, including nested resources and webhooks

Quick Start

Provide a new API design outline for a REST or GraphQL service, including endpoint structure, validation, and error handling.

Frequently Asked Questions about api-design

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I design consistent REST API endpoint naming and structure?

Design REST API endpoints using standardized naming conventions like plural nouns and kebab-case for predictable routes. This approach enforces consistent endpoint structure, coherent schema-based validation, and standardized error responses across your service.

What is the best way to handle API versioning and authentication patterns?

The best way to handle API versioning and authentication is to apply standardized design patterns that enforce consistent security strategies across endpoints. This ensures scalable and secure APIs through coherent schema validation and structured authorization.

How do I standardize error handling and input validation for GraphQL APIs?

Standardize GraphQL API error handling by integrating schema-based input validation and coherent error response patterns. This provides consistent validation mechanisms and predictable error structures for secure, scalable API operations.

Can I use these API design patterns for refactoring existing routes and schemas?

Yes, you can use these API design patterns for refactoring existing routes and documenting schemas. The patterns apply to API-first teams building new endpoints or restructuring current services with standardized endpoint naming and pagination.

Does this approach support nested resources and webhooks for REST endpoints?

Yes, this approach supports nested resources and webhooks for REST endpoints through real-world usage examples. Designing an endpoint set with listing, retrieval, creation, and updates demonstrates how to structure nested resource operations effectively.