skills.rest
NorkzYT
NorkzYTCOMMUNITY
Explore all skills by this author →
GitHub

api-design-principles

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

2|2|Updated Jan 21, 2026
Search Tags:#design#documentation#API#GraphQL#REST#patterns#DataLoader
One-click install
npx skills add https://github.com/NorkzYT/claude-code-autopilot --skill api-design-principles-norkzyt
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/NorkzYT/claude-code-autopilot/tree/main/.claude/skills/api-design-principles
Command: npx skills add https://github.com/NorkzYT/claude-code-autopilot --skill api-design-principles-norkzyt

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill guides teams to design REST and GraphQL APIs that are intuitive, scalable, and easy to maintain.

Core Features & Use Cases

  • REST design patterns: resource naming, HTTP methods, versioning, pagination, and error handling.
  • GraphQL design principles: schema-first development, resolver patterns, and pagination strategies.
  • Use Case: A development team standardizes API design across multiple services to accelerate onboarding and reduce integration friction.

Quick Start

Draft a REST endpoint /api/users and a GraphQL type User with fields id, email, and name, applying the principles described in this Skill.

Frequently Asked Questions about api-design-principles

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

FAQPage Schema
What's the best way to design REST and GraphQL APIs with consistent conventions?▼

Designing REST and GraphQL APIs consistently requires standardizing resource naming, HTTP methods semantics, schema-first development, and error payloads to ensure maintainability and reduce integration friction across services.

How do I prevent N+1 queries in GraphQL resolver patterns?▼

Prevent N+1 queries in GraphQL resolvers by integrating DataLoader patterns to batch and cache database requests, maintaining testable schema-first designs while optimizing data fetching efficiency.

How do I structure standardized error payloads for API design?▼

Structure standardized error payloads for API design by defining consistent conventions for REST HTTP methods and GraphQL schema-first responses, ensuring error handling is uniform and easy for clients to parse.

When do I need schema-first development for GraphQL APIs?▼

You need schema-first development for GraphQL APIs when establishing a schema-first mindset to dictate resolver strategies, pagination, and documentation best practices before implementing backend logic.

Does API design require specific versioning and pagination strategies?▼

Robust API design requires specific versioning and pagination strategies to manage REST resource evolution and GraphQL data fetching, ensuring endpoints remain intuitive and scalable without breaking existing integrations.

Related Skills

Explore More Software Engineering Skills→
aexol-studioaexol-studio
27

axolotl-schema

Generate type-safe GraphQL models and resolver boilerplates from a schema.

Official
Intermediate
TheBushidoCollectiveTheBushidoCollective
187

absinthe-resolvers

Implement Absinthe GraphQL resolvers with Dataloader batching and error handling.

Official
Advanced
yusufcmgyusufcmg
1

api-design-principles

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

Community
Intermediate
fanguyunfanguyun

graphql-architect

Design GraphQL schemas and Apollo Federation with resolver implementations.

Community
Advanced