skills.rest
KaranKathur06
KaranKathur06COMMUNITY
Explore all skills by this author →
GitHub

api-design-principles

Apply resource-oriented routing and schema-first modeling to REST and GraphQL API designs.

Updated Feb 22, 2026
Search Tags:#versioning#error handling#api design#rest#developer experience#graphql#pagination
One-click install
npx skills add https://github.com/KaranKathur06/Metal-Hub --skill api-design-principles-karankathur06
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/KaranKathur06/Metal-Hub/tree/main/.cursor/skills/api-design-principles
Command: npx skills add https://github.com/KaranKathur06/Metal-Hub --skill api-design-principles-karankathur06

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps you avoid confusing, fragile, and hard-to-maintain REST and GraphQL API designs by giving clear, battle-tested principles and patterns.

Core Features & Use Cases

  • REST API architecture guidance: Learn resource-oriented endpoint design, correct HTTP method semantics, pagination, filtering, and consistent error handling.
  • GraphQL schema and resolver patterns: Apply schema-first modeling, Relay-style pagination, and resolver approaches that prevent N+1 problems.
  • Practical standardization for teams: Use API versioning strategies, documentation expectations, and a consistent checklist to improve reviews and migrations.

Quick Start

Use this skill to review your existing REST and GraphQL endpoint designs and standardize them for clarity, scalability, and maintainability.

Frequently Asked Questions about api-design-principles

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

FAQPage Schema
How do I design REST API endpoints with correct HTTP semantics and pagination?▼

REST API design applies resource-oriented routing and correct HTTP method semantics to structure endpoints. It implements consistent pagination and filtering patterns to ensure scalable, predictable data retrieval across resources.

What is the best way to prevent N+1 query problems in GraphQL resolver design?▼

Preventing N+1 query problems in GraphQL resolver design requires applying schema-first modeling and structured resolver patterns. These approaches optimize data fetching by batching requests and safeguarding against query complexity issues.

How do I establish consistent error handling and versioning strategies for API standardization?▼

API standardization establishes consistent error handling and versioning strategies to align endpoint behavior across teams. Applying structured error patterns and versioning rules ensures maintainable, clear API migrations and reviews.

Can I use schema-first modeling to refactor existing GraphQL and REST APIs?▼

Schema-first modeling refactors existing GraphQL and REST APIs by applying structured design principles to current endpoints. It aligns resource-oriented routing and resolver patterns to improve clarity, scalability, and maintainability.

Does API design quality require specific dependencies or environments to implement?▼

API design quality principles require no specific dependencies or environments to implement. The patterns apply universally across REST and GraphQL paradigms to improve endpoint design through resource-oriented routing and consistent standards.

Why are structured error handling and query complexity safeguards important for API developer experience?▼

Structured error handling and query complexity safeguards improve API developer experience by preventing confusing, fragile designs. Consistent error and pagination patterns ensure predictable behavior and maintainable API interactions.

Related Skills

Explore More Software Engineering Skills→
musujmusuj

phase-1-schema

Define project terminology, entities, relationships, and data structures.

Community
Intermediate
UnicornUnicorn

api-design-agent

Design API contracts and documentation for RESTful and GraphQL services.

Official
Intermediate
AcczdyAcczdy
2

implementing-api-abuse-detection-with-rate-limiting

Implement API abuse detection with token bucket, sliding window, and adaptive rate limiting on Redis.

Community
Advanced
duynhneduynhne

rest-api-expert

Design REST APIs with HTTP semantics, endpoint naming, versioning, and OpenAPI documentation.

Community
Intermediate