skills.rest
martiirivass
martiirivassCOMMUNITY
Explore all skills by this author →
GitHub

api-design-principles

Guide REST and GraphQL API design with resource modeling, pagination, versioning, and error handling.

Updated Apr 29, 2026
Search Tags:#design#best practices#api#rest#graphql
One-click install
npx skills add https://github.com/martiirivass/parcialGestionRobledo --skill api-design-principles-martiirivass
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/martiirivass/parcialGestionRobledo/tree/main/.agents/skills/api-design-principles
Command: npx skills add https://github.com/martiirivass/parcialGestionRobledo --skill api-design-principles-martiirivass

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps developers understand and apply fundamental API design principles to create APIs that are intuitive, maintainable, and scalable.

Core Features & Use Cases

  • Guidelines for REST and GraphQL APIs: Establishes effective resource modeling, versioning, and schema design strategies.
  • Design Patterns & Best Practices: Covers resource naming, pagination, error handling, and data fetching optimizations.
  • Use Case: Engineers designing a new public API can leverage these principles to ensure consistency and developer satisfaction across documentation and implementation.

Quick Start

Use the api-design-principles skill to review your current API specifications and identify improvements for clarity and usability.

Frequently Asked Questions about api-design-principles

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

FAQPage Schema
What are the best practices for REST API resource modeling and pagination?▼

REST API best practices for resource modeling involve standardized resource naming, efficient pagination strategies, and consistent data fetching optimizations to build scalable and maintainable interfaces.

How do I design a scalable GraphQL API schema?▼

Designing a scalable GraphQL API schema requires establishing effective schema design strategies and data fetching optimizations to ensure intuitive, maintainable, and developer-friendly interfaces.

How should I handle API versioning and error handling for public APIs?▼

API versioning and error handling should follow standardized design patterns to ensure consistency and developer satisfaction across public API documentation and implementation.

What is the best way to standardize API specifications for clarity and usability?▼

Standardizing API specifications for clarity and usability requires applying fundamental API design principles to review current specifications and identify improvements for consistency.

Do I need specific frameworks to apply these API design principles?▼

No specific frameworks are required as dependencies. These API design principles provide comprehensive guidelines suitable for API architects and developers aiming for standardized interfaces regardless of platform.

Related Skills

Explore More Software Engineering Skills→
VeradelaCruzVeradelaCruz

api-design

Define API requirements and generate OpenAPI or GraphQL schemas.

Community
Intermediate
wojonswojons
4

api-documentation

Generate API documentation for REST/HTTP, gRPC, GraphQL, and RPC APIs.

Community
Intermediate
briannadoubtbriannadoubt

security

Enforce authentication, authorization, rate limiting, and request validation for Trebuchet actors.

Community
Advanced
ccfccf

api-design-principles

Enforce standardized design principles for REST and GraphQL APIs.

Community
Basic