skills.rest
Antony-Figueroa
Antony-FigueroaCOMMUNITY
Explore all skills by this author →
GitHub

api-design-principles

Provide structured REST and GraphQL design principles for API interfaces.

3|1|Updated Dec 25, 2025
Search Tags:#design#versioning#documentation#api#rest#graphql#patterns
One-click install
npx skills add https://github.com/Antony-Figueroa/UNEFA_DASHBOARD --skill api-design-principles-antony-figueroa
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/Antony-Figueroa/UNEFA_DASHBOARD/tree/main/.trae/skills/api-design-principles
Command: npx skills add https://github.com/Antony-Figueroa/UNEFA_DASHBOARD --skill api-design-principles-antony-figueroa

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

Solves API design challenges by providing structured REST and GraphQL principles for scalable, maintainable interfaces.

Core Features & Use Cases

  • REST and GraphQL design principles covering resource naming, HTTP semantics, pagination, versioning, and error handling.
  • Design pattern templates and best practices for API governance, documentation, and adoption across teams.
  • Guidance for migrating between REST and GraphQL paradigms and for reviewing API specifications before implementation.

Quick Start

Describe your API design scenario and I will outline REST or GraphQL design patterns to follow.

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 API design principles for resource naming and pagination?▼

REST API design principles enforce consistent resource naming, HTTP semantics, and pagination structures to create scalable, maintainable, and developer-friendly interfaces across teams.

How do I handle error handling and versioning in GraphQL schema design?▼

GraphQL schema design handles errors and versioning through structured principles that enforce consistent patterns, templates, and best practices for maintaining robust and developer-friendly interfaces.

What's the best way to migrate an existing API from REST to GraphQL?▼

Migrating between REST and GraphQL paradigms requires structured design pattern templates and best practices to review API specifications and ensure scalable, maintainable interface transitions.

How do I establish API governance and documentation standards for a development team?▼

API governance and documentation standards are established through design pattern templates and best practices that enforce consistent guidance for team adoption and robust, developer-friendly interfaces.

Can I use these API design patterns for reviewing API specifications before implementation?▼

Yes, these API design patterns provide structured REST and GraphQL principles specifically for reviewing API specifications before implementation to ensure scalable and maintainable interface design.

Related Skills

Explore More Software Engineering Skills→
Owl-ListenerOwl-Listener
234

design-strategy

Synthesize discovery and research into stakeholder-aligned strategic documents with experience maps and metrics.

Community
Advanced
icartshicartsh
4

api-designer

Design RESTful and GraphQL APIs with OpenAPI 3.0 specifications.

Community
Advanced
3balljugglerYu3balljugglerYu

api-documentation-writer

Generate OpenAPI/Swagger specifications and REST API documentation with endpoint examples.

Community
Advanced
knckknckknckknck

go-style-guide

Standardize Go code quality and style across projects.

Community
Intermediate