skills.rest
DrLuggels
DrLuggelsCOMMUNITY
Explore all skills by this author →
GitHub

api-design-principles

Guide REST and GraphQL API design with versioning, error handling, and pagination.

3|Updated Jan 8, 2026
Search Tags:#api design#rest#graphql#backend development#api patterns#api principles
One-click install
npx skills add https://github.com/DrLuggels/my_dhbw --skill api-design-principles-drluggels
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design-principles
Source: https://github.com/DrLuggels/my_dhbw/tree/main/.claude/plugins/backend-development/skills/api-design-principles
Command: npx skills add https://github.com/DrLuggels/my_dhbw --skill api-design-principles-drluggels

SYSTEM DOCUMENTATION & REQUIREMENTS

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

What problem does it solve?

This Skill helps developers master the principles and patterns for designing robust, user-friendly REST and GraphQL APIs, ensuring scalability and maintainability.

Core Features & Use Cases

  • RESTful Design: Learn resource-oriented architecture, HTTP method semantics, and common patterns like pagination, filtering, and error handling.
  • GraphQL Design: Understand schema-first development, query/mutation structures, and efficient data fetching with DataLoaders.
  • Use Case: When designing a new microservice API, use this Skill to ensure adherence to best practices for both REST and GraphQL, leading to a more consistent and developer-friendly experience.

Quick Start

Use the api-design-principles skill to review the provided API specification against RESTful design best practices.

Frequently Asked Questions about api-design-principles

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

FAQPage Schema
What are the core principles for designing scalable REST and GraphQL APIs?▼

Core API design principles involve resource-oriented architecture for REST and schema-first development for GraphQL to ensure maintainability. This approach guides developers in creating intuitive, scalable backend systems.

How do I handle pagination and error handling in API design?▼

Handling pagination and error handling in API design requires applying common REST and GraphQL patterns specified in the skill. It facilitates structured data fetching and consistent error responses across microservices.

What is the best way to version an API and structure its schema?▼

The best way to version an API and structure its schema is by following established REST and GraphQL design patterns. This ensures backward compatibility and efficient data fetching structures like DataLoaders.

When should I use GraphQL DataLoaders for efficient data fetching?▼

Use GraphQL DataLoaders for efficient data fetching when designing schema-first APIs to solve the N+1 query problem. This pattern optimizes backend development by batching and caching requests.

Can I review an existing API specification against RESTful design best practices?▼

Yes, you can review an existing API specification against RESTful design best practices using the skill. It evaluates resource-oriented architecture, HTTP method semantics, and pagination patterns for adherence to standards.

Related Skills

Explore More Software Engineering Skills→
Fr-e-dFr-e-d
157

architecture-extract

Analyze project directory structures to generate architectural summaries.

Community
Basic
qazuorqazuor

api-app-testing

Plan and implement REST API tests with schema validation and coverage reports.

Community
Advanced
Coffelix2023Coffelix2023
1

code-documenter

Generate inline code documentation, API specifications, and developer guides.

Community
Intermediate
belokonmbelokonm
8

api-documenter

Generate OpenAPI/Swagger specifications and GraphQL schema documentation for RESTful APIs.

Community
Advanced