skills.rest
ashchupliak
ashchupliakCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Design consistent REST API endpoints, DTOs, and versioning patterns.

5|1|Updated Nov 28, 2025
Search Tags:#design#versioning#security#api#rest#dto#http-status
One-click install
npx skills add https://github.com/ashchupliak/dream-team --skill api-design-ashchupliak
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/ashchupliak/dream-team/tree/main/skills/api-design
Command: npx skills add https://github.com/ashchupliak/dream-team --skill api-design-ashchupliak

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

APIs often suffer from inconsistent design, unclear contracts, and brittle evolution. This Skill provides structured REST API design principles to enforce consistency across endpoints, DTOs, and service boundaries.

Core Features & Use Cases

  • URL structure guidelines for resource-oriented endpoints
  • Standard HTTP status codes, error formats, pagination, and response shaping
  • Guidance on versioning, security validations, and request/response contracts
  • Real-world Use Case: design an endpoint for a resources collection with consistent CRUD semantics

Quick Start

Apply these principles to your next REST API by naming endpoints with resource-oriented paths and using the recommended status codes and error formats.

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 REST API URL structure and resource naming?▼

REST API URL structure should follow resource-oriented paths to ensure consistency. This approach standardizes endpoint naming for collections and items, enforcing clear service boundaries and scalable CRUD semantics across microservices.

How do I design consistent REST API DTOs and response models?▼

Designing consistent REST API DTOs involves standardizing request and response models using defined contracts. This ensures consistent data shaping, clear pagination patterns, and uniform error formats across all endpoints.

What HTTP status codes should I use for REST API errors and pagination?▼

Standard HTTP status codes must be applied consistently for REST API operations. Using recommended status codes alongside standardized error formats and pagination patterns ensures predictable client interactions and clear failure communication.

How do I handle REST API versioning and security validations?▼

REST API versioning and security validations are handled by applying structured design principles. Codifying versioning strategies and security checks during endpoint creation prevents brittle evolution and secures service boundaries.

When should I use resource-oriented endpoints for microservices API design?▼

Resource-oriented endpoints should be used when designing REST APIs across microservices to enforce consistent contracts. This approach prevents unclear contracts and brittle API evolution by standardizing CRUD semantics and URL structures.

Does this REST API design approach work for evolving existing endpoint structures?▼

Yes, this REST API design approach works for evolving existing structures by codifying URL paths, HTTP status codes, and versioning. It provides structured principles to resolve inconsistent design and enforce service boundary consistency.

Related Skills

Explore More Software Engineering Skills→
vm0-aivm0-ai
76

twenty

Expose REST and GraphQL APIs to manage Twenty CRM entities.

Official
Intermediate
ChenYCLChenYCL

api-docs

Generate API documentation and OpenAPI 3.0 specs from code or descriptions.

Community
Intermediate
cenjiecenjie

api-security-hardening

Secure REST APIs with authentication, rate limiting, CORS, and input validation.

Community
Advanced
timequitytimequity
6

graphql-api

Design GraphQL schemas, implement resolvers, and enable subscriptions.

Official
Advanced