api-design-skill

Standardize REST and GraphQL API designs with consistent versioning and error formats.

1|1|Updated Mar 22, 2026
One-click install
npx skills add https://github.com/zzafergok/skills --skill api-design-skill-zzafergok
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design-skill
Source: https://github.com/zzafergok/skills/tree/main/05-backend-development/api-design-skill
Command: npx skills add https://github.com/zzafergok/skills --skill api-design-skill-zzafergok

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Developers often ship inconsistent APIs due to ad hoc designs, unclear constraints, and missing standards, which slows integration and increases maintenance burden.

Core Features & Use Cases

  • RESTful design principles: clear resource orientation, stable endpoints, and predictable semantics.
  • GraphQL guidance: effective schema design, query optimization, and avoiding over-fetching.
  • API governance: versioning, standardized error formats, pagination, and route handler patterns to ensure consistency across services.
  • Use Case: When designing a new service, align REST or GraphQL endpoints with the agreed standards to enable rapid onboarding and safe migrations.

Quick Start

Draft an API design plan for a new service using REST or GraphQL, applying the principles described here.

Frequently Asked Questions about api-design-skill

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

FAQPage Schema
How do I standardize API design to reduce inconsistent interfaces across services?

Standardize API design by enforcing RESTful constraints, HTTP status semantics, pagination strategies, error response formats, versioning approaches, and route handler patterns across all backend services to ensure consistency.

When do I need to standardize REST or GraphQL endpoints for a new service?

You need to standardize REST or GraphQL endpoints when designing a new service, reviewing API specifications, or migrating between REST and GraphQL to align with agreed standards and enable rapid onboarding.

What is the best way to handle API versioning and error response formats?

The best way to handle API versioning and error response formats is to apply API governance principles that enforce standardized error formats and consistent versioning approaches across all endpoints.

Can I use this approach for migrating between REST and GraphQL in backend systems?

Yes, you can use this approach for migrations between REST and GraphQL in backend systems by applying RESTful design principles and GraphQL guidance to ensure safe transitions and predictable semantics.

How does GraphQL schema design avoid over-fetching in API endpoints?

GraphQL schema design avoids over-fetching by applying effective query optimization techniques and clear schema design principles, ensuring clients retrieve only the specific data they request.

Why does ad hoc API design increase maintenance burden and slow integration?

Ad hoc API design increases maintenance burden and slows integration because it creates inconsistent APIs due to unclear constraints and missing standards, which hinders rapid onboarding and safe migrations.