api-design-principles

Design REST and GraphQL APIs with schema-first patterns and governance.

Updated Aug 23, 2026

Search Tags:#design #versioning #documentation #GraphQL #REST #OpenAPI #APIs

Ready to run

npx skills add https://github.com/goodnight000/KittyCourt --skill api-design-principles-goodnight000

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/goodnight000/KittyCourt/tree/main/.codex/skills/api-design-principles
Command: npx skills add https://github.com/goodnight000/KittyCourt --skill api-design-principles-goodnight000

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill consolidates REST and GraphQL API design best practices into a practical guide, helping teams avoid common pitfalls and deliver developer-friendly APIs.

Core Features & Use Cases

Schema-first design: Aligns types and operations before implementation to ensure consistency.
Pattern library: Covers REST resources, pagination, versioning, error handling, and GraphQL schemas.
Use cases: Ideal for designing new APIs, reviewing specifications, and standardizing API design across teams. It also provides templates and reference patterns from the assets and references.

Quick Start

Create an API design brief for a new service including REST endpoints, GraphQL schema, pagination, and error handling.

Frequently Asked Questions about api-design-principles

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

FAQPage Schema

What is schema-first design for REST and GraphQL APIs?▼

To design REST and GraphQL APIs, start by creating a design brief covering REST endpoints, GraphQL schema, pagination, and error handling. This skill provides templates and reference patterns to guide the specification process for new services.

How do I standardize API design patterns like pagination and error handling across teams?▼

You can standardize API design patterns using a pattern library that covers REST resources, pagination, versioning, and error handling. This skill consolidates best practices to enforce consistency during architectural reviews and governance across teams.

Can I use this for an architectural review of existing OpenAPI specifications?▼

Yes, you can use this for architectural reviews of existing OpenAPI specifications. It enforces standards-based design guidelines, checking existing REST and GraphQL schemas against best practices for versioning, pagination, and error handling.

What's the best way to version REST and GraphQL APIs to ensure scalability?▼

The best way to version REST and GraphQL APIs for scalability is applying consolidated versioning guidelines and pattern libraries. This skill provides reference patterns to help teams avoid common pitfalls and deliver developer-friendly APIs that scale.

Does this skill support both REST and GraphQL documentation generation?▼

Yes, this skill supports both REST and GraphQL documentation guidelines. It enforces schema-first design and provides reference patterns from its assets to ensure API documentation remains consistent and developer-friendly across new projects.