api-design

Standardize API design practices across REST and GraphQL schemas.

1|Updated Jan 16, 2026
One-click install
npx skills add https://github.com/enact-on/super-ai-github --skill api-design-enact-on
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/enact-on/super-ai-github/tree/main/.opencode/skill/api-design
Command: npx skills add https://github.com/enact-on/super-ai-github --skill api-design-enact-on

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill standardizes and optimizes API design across REST, GraphQL, and API-first approaches, helping teams avoid inconsistent naming, poorly versioned schemas, and unclear error handling.

Core Features & Use Cases

  • Resource naming and versioning standards: guidance on naming endpoints, versioning strategies, and stable contracts.
  • Standardized response and error contracts: templates for success, error payloads, and pagination patterns across REST and GraphQL.
  • OpenAPI and GraphQL guidelines: schema design patterns, resolver strategies, and documentation practices.
  • Use Case: A company migrating from a fragmented API landscape to a single OpenAPI + GraphQL schema with consistent error reporting.

Quick Start

Run a design review by outlining REST and GraphQL schemas, then generate an OpenAPI document and a GraphQL schema skeleton.

Frequently Asked Questions about api-design

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

FAQPage Schema
What are the best practices for REST API resource naming and versioning?

REST API design best practices for resource naming and versioning involve establishing consistent endpoint naming conventions and stable versioning strategies to maintain reliable contracts. This Skill standardizes those patterns to prevent fragmented schemas.

How do I design a standardized error handling contract for GraphQL and REST?

Standardized error handling for GraphQL and REST uses consistent response payloads and error reporting patterns. This Skill provides templates for success, error payloads, and pagination to ensure uniform contracts across different API types.

How do I generate an OpenAPI document from my API schema design?

Generate an OpenAPI document by outlining your REST schema and applying standard schema design patterns. This Skill guides you through creating a valid OpenAPI specification and a GraphQL schema skeleton during a design review.

Can I use this for migrating a fragmented API landscape to a unified schema?

Yes, migrating a fragmented API landscape to a unified schema is a primary use case. This Skill helps teams consolidate inconsistent APIs into a single OpenAPI and GraphQL schema with standardized error reporting.

Does this approach support API-first development and governance tasks?

API-first development and governance are fully supported by applying standardized schemas, versioning, and error handling. This Skill ensures consistent API implementation and documentation practices required for effective governance.

What is the best way to structure GraphQL resolver patterns and schemas?

The best way to structure GraphQL schemas involves applying specific resolver strategies and documentation practices. This Skill provides guidelines for designing robust GraphQL schemas and standardizing resolver patterns effectively.