api-design-principles

Design and review REST and GraphQL APIs for consistency and maintainability.

1|Updated Jan 31, 2026
One-click install
npx skills add https://github.com/boomNDS/soop-discoard-bot --skill api-design-principles-boomnds
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/boomNDS/soop-discoard-bot/tree/main/.agents/skills/api-design-principles
Command: npx skills add https://github.com/boomNDS/soop-discoard-bot --skill api-design-principles-boomnds

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill provides a comprehensive framework for designing and evaluating REST and GraphQL APIs, ensuring consistency, clarity, and long-term maintainability.

Core Features & Use Cases

  • Schema-first guidance: Establishes a solid API schema before implementation, covering resource modeling and type systems.
  • Pattern catalog: Documents pagination, versioning, error handling, authentication, and documentation patterns with concrete examples.
  • Evaluation & governance: Supports API spec reviews, design reviews, and standards creation across teams.
  • Use Case: When starting a new API, run this Skill to generate a standards-compliant design blueprint, including endpoints, payloads, and error formats.

Quick Start

Draft a REST and GraphQL API design blueprint for a new service, including resources, endpoints, authentication, and error handling.

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 a REST and GraphQL API with consistent resource naming and pagination?

Design REST and GraphQL APIs by enforcing established patterns for resource naming, pagination, versioning, and error handling. This approach ensures schema consistency, usability, and long-term maintainability across product teams during API design sessions and specification reviews.

What's the best way to create an API design blueprint for a new service?

Draft a standards-compliant API design blueprint by modeling resources, endpoints, authentication, and error formats before implementation. This schema-first guidance establishes a solid foundation covering type systems and resource modeling for REST and GraphQL architectures.

How does schema-first API design improve long-term maintainability?

Schema-first API design improves maintainability by establishing a clear schema before implementation, covering type systems and resource modeling. This framework enforces consistency in pagination, versioning, and error handling, preventing architectural drift across product teams.

Can I use this API design framework for specification reviews and standards formation?

Yes, you can use this framework for API spec reviews, design evaluations, and standards creation across teams. It provides evaluation and governance support by referencing templates, checklists, and example schemas to validate API consistency and usability.

REST vs GraphQL API design: how do I handle error handling and versioning patterns?

Handle error handling and versioning by applying documented patterns from a comprehensive catalog for both REST and GraphQL APIs. This framework provides concrete examples for authentication, pagination, and versioning to ensure consistent schema design across different architectural styles.