api-design

Design REST APIs with consistent naming, error handling, and versioning.

8|Updated Apr 9, 2026
One-click install
npx skills add https://github.com/D0NMEGA/donnyclaude --skill api-design-d0nmega
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/D0NMEGA/donnyclaude/tree/main/packages/skills/api-design
Command: npx skills add https://github.com/D0NMEGA/donnyclaude --skill api-design-d0nmega

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

REST API design often becomes inconsistent across teams, causing integration difficulties and fragile contracts.

Core Features & Use Cases

  • Resource naming conventions and stable URL structures
  • Standardized error handling, pagination, filtering, and versioning strategies
  • Guidance for public, partner, and internal API contracts

Quick Start

Implement a production-ready REST API following these patterns.

Frequently Asked Questions about api-design

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

FAQPage Schema
What is the best way to design REST API URL naming conventions?

REST API naming conventions standardize endpoint paths using resource-based nouns and consistent structures. This approach ensures URL structures remain stable and predictable across public, partner, and internal service contracts.

How do I handle errors and pagination in a REST API?

Error handling and pagination in a REST API require standardized error formats and consistent pagination strategies. Implementing these patterns ensures clients receive predictable responses and can efficiently navigate large datasets.

How does API versioning work for public and internal services?

API versioning for public and internal services maintains contract stability by applying versioning strategies to endpoints. This prevents breaking changes for existing consumers while allowing the API to evolve securely.

What are the HTTP method semantics for endpoint design?

HTTP method semantics for endpoint design dictate the use of specific verbs like GET, POST, PUT, and DELETE to perform operations on resources. Adhering to these semantics ensures RESTful contracts remain lightweight and predictable.

Why does my REST API design cause integration difficulties across teams?

REST API design causes integration difficulties when teams lack consistent naming, error handling, and versioning. Applying standardized URL naming conventions and lightweight validation rules resolves these fragile contract issues.