skills.rest
HyNuwa
HyNuwaCOMMUNITY
Explore all skills by this author →
GitHub

api-design-principles

Guide RESTful and GraphQL API design with principles and patterns.

Updated Nov 24, 2025
Search Tags:#api design#rest#developer experience#graphql#api patterns#api principles
One-click install
npx skills add https://github.com/HyNuwa/ResuMate --skill api-design-principles-hynuwa
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/HyNuwa/ResuMate/tree/main/.agents/skills/api-design-principles
Command: npx skills add https://github.com/HyNuwa/ResuMate --skill api-design-principles-hynuwa

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps developers design, review, and standardize intuitive, scalable, and maintainable REST and GraphQL APIs, improving developer experience and reducing maintenance overhead.

Core Features & Use Cases

  • API Design Guidance: Provides principles and patterns for both RESTful and GraphQL API design.
  • Best Practices & Pitfalls: Highlights common mistakes and offers solutions for robust API development.
  • Use Case: A team is starting a new microservice and needs to define its API. They can use this Skill to ensure they follow established REST principles for resource naming, HTTP methods, and error handling, leading to a more consistent and developer-friendly API.

Quick Start

Use the api-design-principles skill to get a checklist for reviewing a new REST API design.

Frequently Asked Questions about api-design-principles

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

FAQPage Schema
What are the core principles for designing RESTful APIs?▼

GraphQL API schema design involves defining typed schemas, queries, and mutations. This Skill provides best practices for creating maintainable schemas and avoiding common pitfalls in GraphQL API development.

How do I handle pagination and errors in API design?▼

API design for pagination and errors requires structured patterns. This Skill offers guidance on implementing consistent pagination strategies and standardized error handling for both REST and GraphQL paradigms.

What is the best way to standardize microservice API design?▼

Standardizing microservice API design involves following established patterns for resource naming and HTTP methods. This Skill provides a checklist to review new APIs, ensuring consistency and improved developer experience.

Does this API design guidance cover both REST and GraphQL paradigms?▼

Yes, this API design guidance covers both REST and GraphQL paradigms. It provides comprehensive patterns and best practices for designing intuitive, scalable APIs across both architectural styles.

When should I choose GraphQL over REST for my API?▼

Choosing GraphQL over REST depends on your data fetching needs. This Skill outlines the principles and patterns for both paradigms, helping you decide the appropriate approach for your specific API requirements.

Related Skills

Explore More Software Engineering Skills→
nicholasgriffintnnicholasgriffintn
2

backend-design

Plan backend systems, APIs, and data models with structured architecture decisions.

Community
Basic
curiositechcuriositech
181

openapi-spec-writer

Generate OpenAPI 3.0/3.1 YAML or JSON specifications for REST APIs.

Official
Advanced
rsmdtrsmdt
381

api-design-patterns

Apply standardized REST and GraphQL design patterns to API contracts and versioning.

Community
Advanced
agi-house-indiaagi-house-india

api-design-principles

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

Official
Advanced