skills.rest
Dsantiagomj
DsantiagomjCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

api-design

Design REST and GraphQL APIs with patterns for methods, status codes, pagination, and versioning.

Updated Aug 23, 2026
Search Tags:#design#versioning#API#validation#GraphQL#REST
One-click install
npx skills add https://github.com/Dsantiagomj/DSMJ-Ai-Toolkit --skill api-design-dsantiagomj
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/Dsantiagomj/DSMJ-Ai-Toolkit/tree/main/skills/domain/api-design
Command: npx skills add https://github.com/Dsantiagomj/DSMJ-Ai-Toolkit --skill api-design-dsantiagomj

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill helps teams design RESTful and GraphQL APIs with consistent contracts, clear patterns, and reusable templates, reducing integration headaches and drift across services.

Core Features & Use Cases

  • Pattern mastery: REST and GraphQL design patterns including HTTP methods, status codes, resource naming, pagination, versioning, and error handling.
  • Schema & performance: GraphQL schema design with relationships and DataLoader guidance to avoid N+1 queries; REST response shaping and input validation strategies.
  • Practical use cases: Draft API contracts for new services, translate business requirements into endpoints and queries, and enforce consistent API semantics across teams.

Quick Start

Draft a complete API design blueprint for a new service, including REST endpoints and a GraphQL schema.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design a consistent REST API with proper status codes and pagination?▼

Designing a consistent REST API requires structured patterns for HTTP methods, status codes, resource naming, pagination, and error handling to ensure clear contracts and reduce integration drift across services.

What is the best way to prevent N+1 queries when designing a GraphQL schema?▼

Preventing N+1 queries in GraphQL schema design involves using explicit patterns for schema relationships and DataLoader guidance to optimize data fetching and ensure scalable API performance.

How do I handle API versioning and error handling for backend services?▼

API versioning and error handling for backend services require explicit design patterns to maintain consistent API semantics, enforce clear schemas, and satisfy requirements for scalable guidance across teams.

Can I translate business requirements into REST endpoints and GraphQL queries?▼

Translating business requirements into REST endpoints and GraphQL queries is a core use case that involves drafting API contracts for new services and enforcing consistent semantics across teams.

Does this API design guidance cover input validation and response shaping?▼

API design guidance covers REST response shaping and input validation strategies, applying to backend API design work across services to satisfy requirements for clear contracts and reusable templates.

Related Skills

Explore More Software Engineering Skills→
allenlin90allenlin90
1

shared-api-types

Define shared Zod schemas and TypeScript types for API contracts.

Community
Advanced
Prathmesh2000Prathmesh2000
1

schema-designer

Generate PostgreSQL, OpenAPI, JSON Schema, and GraphQL schemas with migration guidance.

Community
Advanced
sami-abdulsami-abdul
3

backend-code

Build REST or GraphQL endpoints with database operations and generate API_SUMMARY.md contracts.

Community
Advanced
rsmdtrsmdt
381

api-design-patterns

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

Community
Advanced