api-design-patterns

Enforce standardized REST and GraphQL API conventions across services.

Updated Jul 10, 2025
One-click install
npx skills add https://github.com/damilola-elegbede-org/claude-config-5ad01dbe --skill api-design-patterns-damilola-elegbede-org
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design-patterns
Source: https://github.com/damilola-elegbede-org/claude-config-5ad01dbe/tree/main/system-configs/.claude/skills/api-design-patterns
Command: npx skills add https://github.com/damilola-elegbede-org/claude-config-5ad01dbe --skill api-design-patterns-damilola-elegbede-org

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Inconsistent REST and GraphQL API conventions across services lead to integration difficulties, onboarding friction, and higher maintenance costs.

Core Features & Use Cases

  • REST conventions: resource naming, HTTP methods, status codes, pagination, and filtering.
  • GraphQL conventions: query and mutation naming, input types, and error schemas.
  • Versioning and standardized response formats to support both public and internal APIs and long-term compatibility.

Quick Start

Enforce standardized REST and GraphQL API conventions.

Frequently Asked Questions about api-design-patterns

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

FAQPage Schema
How do I enforce consistent REST API naming conventions and pagination across services?

Standardized REST API naming conventions and pagination are enforced by specifying resource naming, HTTP methods, status codes, and filtering rules. This ensures consistent public and internal service integration and reduces onboarding friction.

What are the best GraphQL conventions for naming queries, mutations, and error schemas?

The best GraphQL conventions standardize query and mutation naming, input types, and error schemas. Applying these standardized patterns ensures consistent API design and reduces integration difficulties across internal and public services.

How do I handle API versioning and response formats for long-term compatibility?

API versioning and standardized response formats handle long-term compatibility by enforcing consistent conventions across public and internal APIs. This prevents breaking changes and maintains predictable service integration over time.

Do I need specific API design patterns for both REST and GraphQL in my service?

You need standardized API design patterns for both REST and GraphQL to resolve inconsistent conventions. Applying uniform resource naming, error handling, and response formats across services prevents integration difficulties and higher maintenance costs.

Why does inconsistent API design cause integration difficulties and higher maintenance costs?

Inconsistent API design causes integration difficulties and higher maintenance costs because varying REST and GraphQL conventions create onboarding friction. Standardizing versioning, error handling, and response formats resolves these service integration issues.