skills.rest
dtbuchholz
dtbuchholzCOMMUNITY
Explore all skills by this author →
Website𝕏@dtbuchholzGitHub

api-design

Guide RESTful and GraphQL API design covering endpoints, schemas, and error handling.

Updated Jan 22, 2026
Search Tags:#design#best practices#documentation#api#rest#graphql
One-click install
npx skills add https://github.com/dtbuchholz/claude-config --skill api-design-dtbuchholz
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/dtbuchholz/claude-config/tree/main/skills/api-design
Command: npx skills add https://github.com/dtbuchholz/claude-config --skill api-design-dtbuchholz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps developers design robust, user-friendly APIs by providing best practices for REST and GraphQL, error handling, and versioning.

Core Features & Use Cases

  • API Design Principles: Learn REST conventions, HTTP methods, and status codes.
  • Schema Design: Understand best practices for request and response bodies.
  • Error Handling: Implement consistent and informative error responses.
  • Pagination & Versioning: Strategies for managing large datasets and API evolution.
  • Use Case: When designing a new /users endpoint, use this skill to ensure consistent naming, appropriate HTTP methods (e.g., GET, POST), and a clear error response format for invalid inputs.

Quick Start

Use the api-design skill to generate a standard error response format for a 404 Not Found error.

Frequently Asked Questions about api-design

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

FAQPage Schema
What are the best practices for RESTful API endpoint naming conventions and HTTP methods?▼

RESTful API design best practices involve using consistent resource-based paths and appropriate HTTP methods like GET and POST to ensure clean, maintainable endpoint structure and optimal developer experience.

How do I design a consistent error handling response schema for invalid API inputs?▼

Designing consistent API error handling involves implementing a standardized response schema for invalid inputs, ensuring error messages are informative and maintainable across all REST and GraphQL endpoints.

What is the best way to implement pagination and versioning for large datasets in an API?▼

The best way to implement API pagination and versioning involves adopting specific strategies for managing large datasets and API evolution, ensuring consistent request and response schemas while maintaining backward compatibility.

How does GraphQL compare to REST for designing consistent request and response schemas?▼

GraphQL and REST differ in schema design flexibility, with GraphQL allowing clients to query specific data fields and REST relying on predefined endpoint structures, both requiring consistent naming conventions and robust authentication for maintainability.

When do I need API versioning and what HTTP status codes should I use for authentication?▼

API versioning is needed when evolving your endpoint structure without breaking existing clients, and appropriate HTTP status codes must be applied to clearly communicate authentication errors and request successes.

Related Skills

Explore More Software Engineering Skills→
pingmepipingmepi

pm-stage-01-brief

Generate a structured 7-section product brief from a business statement.

Community
Advanced
datorresbdatorresb

api-documentation

Generate API documentation for REST, GraphQL, gRPC, and WebSocket APIs.

Community
Intermediate
VoTruongDanhVoTruongDanh

rest-api-expert

Provide REST API design guidelines for endpoints, methods, status codes, and versioning.

Community
Advanced
nahisahonahisaho
69

api-designer

Design RESTful, GraphQL, and gRPC APIs with OpenAPI and Protobuf definitions.

Community
Intermediate