api-design-principles

Guide REST and GraphQL API design, refactoring, standards, and documentation.

Updated Dec 18, 2025
One-click install
npx skills add https://github.com/JesusFigueroa25/SEABOT --skill api-design-principles-jesusfigueroa25
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/JesusFigueroa25/SEABOT/tree/main/PROYECTO/fronted-seabot/.agents/skills/api-design-principles
Command: npx skills add https://github.com/JesusFigueroa25/SEABOT --skill api-design-principles-jesusfigueroa25

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps in mastering REST and GraphQL API design principles, enabling the creation of intuitive, scalable, and maintainable APIs.

Core Features & Use Cases

  • API Design Education: Offers a comprehensive guide to REST and GraphQL API design.
  • API Refactoring: Assists in refactoring existing APIs for better usability.
  • Standard Establishment: Helps establish API design standards for teams.
  • Documentation Creation: Generates developer-friendly API documentation.
  • API Migrations: Assists in migrating between API paradigms (REST to GraphQL, etc.).

Quick Start

To begin, read through the 'resources/implementation-playbook.md' for detailed patterns, checklists, and templates.

Frequently Asked Questions about api-design-principles

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

FAQPage Schema
What are the key REST and GraphQL API design principles for building maintainable APIs?

Key REST and GraphQL API design principles focus on creating intuitive, scalable, and maintainable APIs by applying comprehensive patterns, checklists, and templates to solve poor design problems.

How do I establish API design standards for my software development team?

To establish API design standards, use a comprehensive implementation playbook that provides detailed patterns and checklists, ensuring your team creates consistent and developer-friendly API documentation.

How do I migrate an existing REST API to GraphQL?

Migrating an existing REST API to GraphQL requires understanding both API paradigms to refactor endpoints effectively, ensuring the new schema maintains usability and scalability throughout the migration process.

What is the best way to refactor existing APIs for better usability?

The best way to refactor existing APIs for better usability is by applying established REST and GraphQL design principles, leveraging detailed implementation patterns to restructure endpoints intuitively.

Do I need prior knowledge of API paradigms to use these API design principles?

Yes, understanding of API paradigms and the ability to implement design principles are required to effectively apply these REST and GraphQL API design guidelines and execute refactoring or migrations.

Why does poor API design affect software scalability and how can I fix it?

Poor API design affects software scalability by creating unintuitive and unmaintainable endpoints; you can fix it by applying comprehensive REST and GraphQL design principles to refactor and standardize interfaces.