skills.rest
LumenWipe
LumenWipeOFFICIAL
Explore all skills by this author →
WebsiteGitHub

api-design-principles

Design REST and GraphQL APIs with resource-oriented modeling and HTTP semantics.

3|1|Updated May 12, 2026
Search Tags:#error handling#api design#openapi#rest#graphql#pagination#api versioning
One-click install
npx skills add https://github.com/LumenWipe/lumenwipe --skill api-design-principles-lumenwipe
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/LumenWipe/lumenwipe/tree/main/.claude/skills/api-design-principles
Command: npx skills add https://github.com/LumenWipe/lumenwipe --skill api-design-principles-lumenwipe

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill replaces inconsistent, difficult-to-maintain API designs with clear, scalable REST and GraphQL interfaces that are easier for developers to understand, integrate, test, and evolve.

Core Features & Use Cases

  • REST API Design: Structure resource-oriented endpoints, apply HTTP methods and status codes correctly, and design reliable pagination, filtering, versioning, and error responses.
  • GraphQL Schema Design: Create strongly typed schemas with effective queries, mutations, pagination, custom scalars, payload errors, and schema evolution strategies.
  • Production Guidance: Address authentication, authorization, rate limiting, CORS, caching, monitoring, documentation, validation, and N+1 query prevention.
  • Use Case: Apply the Skill when reviewing an API specification, designing a new service, migrating between REST and GraphQL, or establishing organization-wide API standards.

Quick Start

Use the API design principles skill to review my proposed API specification and recommend improvements to its resources, pagination, errors, security, versioning, and documentation.

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 pagination and error handling for scalability?▼

Design REST APIs by structuring resource-oriented endpoints, applying correct HTTP methods and status codes, and implementing reliable pagination, filtering, and structured error responses to improve long-term usability.

What is the best way to migrate from REST to GraphQL schemas?▼

Migrate from REST to GraphQL by creating strongly typed schemas with effective queries, mutations, and pagination, replacing inconsistent endpoints with scalable interfaces that improve developer integration.

How do I review an OpenAPI specification for API versioning and security?▼

Review OpenAPI specifications by validating resource modeling, HTTP semantics, authentication, rate limiting, and schema versioning, then recommend improvements to align with organization-wide API standards.

Does this approach support GraphQL N+1 query prevention and rate limiting?▼

Yes, GraphQL N+1 query prevention and rate limiting are supported through production guidance addressing authentication, authorization, CORS, caching, monitoring, and performance controls for scalable schemas.

When should I establish organization-wide API design standards?▼

Establish organization-wide API design standards when reviewing specifications, designing new services, migrating between REST and GraphQL, or replacing inconsistent interfaces with scalable, maintainable architectures.

Related Skills

Explore More Software Engineering Skills→
VXerysVXerys

api-designer

Design REST and GraphQL APIs with OpenAPI 3.1 specifications.

Community
Advanced
missBergmissBerg
3

eg-api-gateway

Enables the setup of a full-featured, secure, and reliable service mesh with a single command.

Community
Advanced
heaptracetechnologyheaptracetechnology
13

contract-test

Automate API contract testing with schema validation and OpenAPI checks.

Community
Advanced
nateanatea

api-testing-patterns

Generate API test coverage from OpenAPI specifications across REST and GraphQL.

Community
Advanced