skills.rest
atthawat-cha
atthawat-chaCOMMUNITY
Explore all skills by this author →
GitHub

api-design-principles

Guide REST and GraphQL API design with patterns and best practices.

Updated Feb 10, 2026
Search Tags:#web development#api design#rest#graphql#software architecture
One-click install
npx skills add https://github.com/atthawat-cha/next_rfs_report_finder_system --skill api-design-principles-atthawat-cha
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/atthawat-cha/next_rfs_report_finder_system/tree/main/.agents/skills/api-design-principles
Command: npx skills add https://github.com/atthawat-cha/next_rfs_report_finder_system --skill api-design-principles-atthawat-cha

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps you master REST and GraphQL API design principles, enabling you to build APIs that are intuitive, scalable, and maintainable.

Core Features & Use Cases

  • RESTful Design Principles: Learn about resource-oriented architecture, HTTP methods, and status codes.
  • GraphQL Design Principles: Understand schema-first development, query structure, and pagination.
  • API Versioning Strategies: Explore URL, header, and query parameter versioning strategies.
  • API Design Patterns: Learn about resource collection design, pagination, error handling, and HATEOAS.
  • GraphQL Design Patterns: Understand schema design, resolver design, DataLoader, and subscriptions.
  • Best Practices: Get guidance on consistent naming, stateless design, versioning, and security.
  • Common Pitfalls: Avoid common mistakes in API design and development.

Quick Start

Use the api-design-principles skill to review the API design of your next project.

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 a scalable REST API?▼

REST and GraphQL API design patterns differ significantly: REST uses resource-oriented architecture with HTTP methods and status codes, while GraphQL uses schema-first development with structured queries, resolvers, and DataLoader for optimized data fetching.

How do I handle pagination and error handling in API design?▼

API design patterns for pagination and error handling involve specific resource collection structuring and standardized error responses. Implementing these best practices ensures your REST or GraphQL APIs handle large datasets and failures gracefully.

What are the best API versioning strategies for maintainability?▼

The best API versioning strategies for maintainability include URL, header, and query parameter versioning. Choosing the right strategy prevents breaking existing clients while allowing your REST or GraphQL API to evolve securely.

What are common pitfalls in GraphQL schema design?▼

Common GraphQL schema design pitfalls include poorly structured queries, inefficient resolver design, and overlooking pagination. Avoiding these mistakes through schema-first development ensures your GraphQL API remains scalable and performant.

Do I need prior web development knowledge to use these API design patterns?▼

Yes, you need prior web development and programming knowledge to apply these API design patterns. The guidelines focus on advanced software architecture concepts, assuming you understand REST, GraphQL, and stateless design fundamentals.

Related Skills

Explore More Software Engineering Skills→
Fr-e-dFr-e-d
157

architecture-extract

Analyze project directory structures to generate architectural summaries.

Community
Basic
NorkzYTNorkzYT
2

api-design-principles

Design REST and GraphQL APIs with consistent conventions and schema-first patterns.

Community
Advanced
mahg-esmahg-es
3

api-gateway

Design and configure API gateways for routing, authentication, and traffic management.

Official
Advanced
felvieirafelvieira
22

backend-api

Define API contracts and data models for Node.js backend applications.

Community
Advanced