skills.rest
AratKruglik
AratKruglikCOMMUNITY
Explore all skills by this author →
GitHub

api-design-principles

Design REST and GraphQL APIs with resource modeling and error handling.

150|51|Updated Mar 14, 2026
Search Tags:#api design#rest#developer experience#graphql#api architecture#api principles
One-click install
npx skills add https://github.com/AratKruglik/claude-laravel --skill api-design-principles-aratkruglik
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/AratKruglik/claude-laravel/tree/main/.claude/skills/api-design-principles
Command: npx skills add https://github.com/AratKruglik/claude-laravel --skill api-design-principles-aratkruglik

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill addresses the challenge of creating well-structured, developer-friendly APIs that are easy to understand, maintain, and scale, preventing common design pitfalls.

Core Features & Use Cases

  • REST & GraphQL Guidance: Provides principles and patterns for designing both RESTful and GraphQL APIs.
  • Best Practices: Covers resource naming, HTTP methods, status codes, pagination, versioning, error handling, and security.
  • Use Case: A development team needs to design a new public-facing API. This Skill will guide them through defining resources, choosing appropriate HTTP methods, establishing a clear versioning strategy, and implementing robust error handling to ensure a positive developer experience.

Quick Start

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

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

Scalable REST API design requires proper resource modeling, standard HTTP methods, clear status codes, and robust versioning. Applying these principles ensures your API remains intuitive and maintainable for developers as it grows.

REST vs GraphQL: when should I choose GraphQL for API architecture?▼

GraphQL is beneficial when clients need flexible data fetching and complex resource relationships. REST remains effective for standardized resource modeling, so choosing GraphQL depends on specific developer experience and data querying needs.

How do I implement robust error handling and pagination in APIs?▼

Robust API error handling uses consistent status codes and clear error payloads. Pagination controls large result sets through standard techniques, ensuring reliable performance and a positive developer experience across endpoints.

What should be included in an API specification review checklist?▼

An API specification review checklist verifies resource naming, HTTP method usage, authentication, error handling, and versioning. Reviewing these elements prevents common design pitfalls and ensures the API is developer-friendly.

How do I migrate an API architecture from REST to GraphQL?▼

Migrating API paradigms involves evaluating GraphQL schema design against existing REST resources. Establish new standards for type definitions and resolvers while maintaining authentication and performance optimization.

Related Skills

Explore More Software Engineering Skills→
nicholasgriffintnnicholasgriffintn
2

backend-design

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

Community
Basic
infinith4infinith4
1

api-spec

Generate OpenAPI 3.0 specifications with schemas, paths, and examples for REST APIs.

Community
Advanced
microwindmicrowind
65

API网关设计

Design API gateways for routing, security, and traffic management in microservices.

Official
Advanced
Dokkabei97Dokkabei97
2

api-first-design

Design API contracts with OpenAPI and GraphQL schemas.

Community
Intermediate