api-design

Define API requirements and generate OpenAPI or GraphQL schemas.

Updated Nov 4, 2025
One-click install
npx skills add https://github.com/VeradelaCruz/gym-manager --skill api-design-veradelacruz
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/VeradelaCruz/gym-manager/tree/main/.agents/skills/api-design
Command: npx skills add https://github.com/VeradelaCruz/gym-manager --skill api-design-veradelacruz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Design RESTful and GraphQL APIs following best practices to ensure scalable, maintainable interfaces across teams and products.

Core Features & Use Cases

  • OpenAPI and GraphQL schema design guidance
  • Versioning strategies, endpoint consistency, and documentation
  • Collaboration and onboarding support for API consumers and implementers

Quick Start

Define the API requirements and generate an initial OpenAPI or GraphQL schema to begin the design.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design REST and GraphQL APIs with consistent schemas and error handling?

To design REST and GraphQL APIs with consistent schemas, apply established design standards to define robust naming, pagination, and error handling. Capture these specifications in OpenAPI or GraphQL outputs for production contexts.

What is the best way to version APIs in production environments?

The best way to version APIs in production involves applying consistent design standards across new and refactored endpoints. Establish clear versioning strategies and document them in OpenAPI specifications to maintain stability.

How do I generate OpenAPI specifications for new endpoints?

To generate OpenAPI specifications for new endpoints, define your API requirements first, then apply design standards to capture robust schemas, naming, and documentation directly into the OpenAPI output.

Does this API design approach work for both new and refactored endpoints?

Yes, this API design approach works for both new and refactored endpoints. It establishes consistent REST and GraphQL design standards that ensure schema robustness and endpoint consistency across production contexts.

How do I structure GraphQL schema documentation for API consumers?

To structure GraphQL schema documentation for API consumers, define API requirements and apply design standards. Ensure robust schemas, naming, and error handling are captured in the GraphQL outputs for onboarding.

What are the limitations of designing APIs without consistent standards?

Designing APIs without consistent standards leads to fragile interfaces and poor maintainability. Applying structured design standards for schemas, versioning, and documentation across endpoints prevents these integration issues.