api-design

Standardize REST API endpoints, DTO structures, and versioning strategies.

4|1|Updated Jan 23, 2026

Search Tags:#design #versioning #REST API #guidelines #endpoints #DTOs #HTTP-status

Ready to run

npx skills add https://github.com/AndVl1/claude-plugin --skill api-design-andvl1

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/AndVl1/claude-plugin/tree/main/skills/api-design
Command: npx skills add https://github.com/AndVl1/claude-plugin --skill api-design-andvl1

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Designing REST APIs and DTOs consistently across services is error-prone and slows development.

Core Features & Use Cases

API Contracting: Establish consistent URL structures, resource naming, and versioning across endpoints.
DTO Modeling: Provide guidelines for request/response payload shapes, validation, and typing.
Error Handling & Status Codes: Standardize HTTP status usage and error payload formats for predictable client behavior.
Use Case: When starting a new service, follow these principles to produce a coherent API surface with clear documentation and versioned contracts.

Quick Start

Start by outlining your top-level resources and versioning strategy, then apply the REST API design principles to define endpoints, DTOs, and error responses.

Frequently Asked Questions about api-design

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

FAQPage Schema

How do I design REST API endpoints and DTOs consistently across backend teams?▼

To design REST API endpoints and DTOs consistently, establish standard URL structure conventions, resource naming, and versioning strategies. Apply guidelines for request and response payload shapes, validation, and typing to ensure a coherent API surface across services.

What is the best way to standardize HTTP status codes and error handling in a REST API?▼

The best way to standardize HTTP status codes and error handling is to enforce consistent HTTP status usage and standardize error payload formats. This creates predictable client behavior across all new service endpoints and DTO responses.

How do I plan versioning strategies for new REST API services?▼

Plan versioning strategies for new REST API services by outlining top-level resources first, then applying design principles to define versioned contracts. This ensures clear documentation and consistent endpoint structures as the API evolves.

Can I use these REST API guidelines for DTO modeling and payload validation?▼

Yes, you can use these REST API guidelines for DTO modeling. They provide specific rules for request and response payload shapes, validation, and typing to maintain consistent data transfer objects across your backend teams.

When do I need to define a versioned contract for my REST API?▼

You need to define a versioned contract for your REST API when starting a new service and establishing endpoint planning. It enforces URL structure conventions and response formats, preventing breaking changes from disrupting predictable client behavior.