api-design

Standardize REST and GraphQL API design with versioning and RFC 7807 errors.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/DaichiHoshina/ai-tools --skill api-design-daichihoshina
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/DaichiHoshina/ai-tools/tree/main/claude-code/skills/api-design
Command: npx skills add https://github.com/DaichiHoshina/ai-tools --skill api-design-daichihoshina

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

API design is often inconsistent across services; this skill standardizes REST/GraphQL design patterns, versioning, error handling, and documentation guidelines to reduce churn and improve interoperability.

Core Features & Use Cases

  • Standardized REST resource patterns, good routes, and status code usage
  • GraphQL schema design guidance, pagination strategies, and data fetching optimizations
  • Versioning strategies, OpenAPI/GraphQL docs, and RFC 7807 compliant error responses
  • Use Case: teams shipping multiple microservices can align API design quickly to reduce integration costs and onboarding friction

Quick Start

Read the API design guidelines and apply them to your next endpoint design.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I standardize REST API design across multiple microservices?

To standardize REST API design across microservices, apply consistent resource patterns, route structures, and status code usage. This approach enforces OpenAPI schema conformance and reduces integration costs by aligning endpoint design quickly across teams.

What is the best way to handle API error handling and formatting consistently?

Consistent API error handling is achieved by enforcing RFC 7807 compliant error response formats. This standardizes error payloads across services, reducing ambiguity and improving interoperability during endpoint integration.

How do I design GraphQL schemas with efficient data fetching and pagination?

Designing GraphQL schemas with efficient data fetching requires applying specific pagination strategies and data fetching optimizations. This skill provides schema design guidance to structure endpoints and reduce query overhead.

What API versioning strategies should I use for REST and GraphQL endpoints?

API versioning strategies for REST and GraphQL endpoints should follow clear versioning guidelines to manage breaking changes. Applying structured versioning workflows alongside OpenAPI or GraphQL documentation maintains service interoperability.

Does this API design guideline work for both REST and GraphQL documentation workflows?

Yes, this API design guideline works for both REST and GraphQL documentation workflows. It enforces OpenAPI and GraphQL schema conformance, applying standardized patterns to reduce inconsistency across both endpoint types.

Why do my API endpoints have inconsistent status codes and routes across different services?

Inconsistent API endpoints often result from lacking standardized REST resource patterns and route guidelines. Applying a unified API design skill enforces good routes and status code usage, reducing churn and onboarding friction.