api-design-principles

Design REST and GraphQL API patterns with versioning, pagination, and error handling standards.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/Hanseooo/hanseo-opencode-workflows --skill api-design-principles-hanseooo
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/Hanseooo/hanseo-opencode-workflows/tree/main/skills/api-design-principles
Command: npx skills add https://github.com/Hanseooo/hanseo-opencode-workflows --skill api-design-principles-hanseooo

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes assets (resource) and references (resource) components.

What problem does it solve?

Design robust REST and GraphQL APIs with clear guidelines and patterns to accelerate development and improve consistency.

Core Features & Use Cases

  • REST design patterns: resource-oriented design, proper HTTP methods, and versioning strategies.
  • GraphQL design principles: schema-first development, pagination, and resolver patterns.
  • Best practices for error handling, documentation, monitoring, and security.
  • Use Case: architecting a new API service or auditing an existing API for consistency.

Quick Start

Draft a comprehensive API design standard for a new service, including REST and GraphQL sections with example endpoints and schemas.

Frequently Asked Questions about api-design-principles

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

FAQPage Schema
How do I design REST and GraphQL API patterns for scalable services?

Design REST and GraphQL API patterns by applying resource-oriented design, schema-first development, and standard versioning strategies to build scalable services. This ensures robust architecture and consistency across new projects and existing API governance.

What are the best practices for REST API error handling and pagination?

Best practices for REST API error handling and pagination involve establishing clear documentation standards and consistent resolver patterns. Applying these guidelines to your API governance accelerates development and improves overall service consistency.

When do I need to establish API governance and versioning strategies?

You need to establish API governance and versioning strategies when architecting a new API service or auditing an existing API for consistency. Standardizing REST and GraphQL sections with example endpoints ensures scalable and maintainable services.

Does this API design approach support both REST and GraphQL schema-first development?

Yes, this API design approach supports both REST and GraphQL schema-first development by providing comprehensive design standards. It includes specific patterns for resource-oriented REST endpoints and GraphQL schemas, ensuring consistent implementation across your services.

What is the best way to audit an existing API for consistency and security?

The best way to audit an existing API for consistency and security is to evaluate it against established design patterns and best practices. Reviewing REST and GraphQL endpoints for proper HTTP methods, error handling, and documentation standards improves robustness.