skills.rest
MLGBJDLW
MLGBJDLWCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Standardize REST and HTTP API design with resource naming, versioning, and error schemas.

1|Updated Jan 22, 2026
Search Tags:#design#versioning#api#validation#rest#endpoints#pagination
One-click install
npx skills add https://github.com/MLGBJDLW/vellum --skill api-design-mlgbjdlw
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/MLGBJDLW/vellum/tree/main/packages/core/src/skill/builtin/api-design
Command: npx skills add https://github.com/MLGBJDLW/vellum --skill api-design-mlgbjdlw

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

APIs often suffer from inconsistent naming, unclear error handling, and missing versioning, making integration painful. This Skill provides a comprehensive, opinionated guide to REST and HTTP API design that improves consistency and developer experience.

Core Features & Use Cases

  • Resource-based URL design with kebab-case and versioning strategies
  • Standardized response and error formats, including pagination and idempotent operations
  • Clear validation patterns and OpenAPI-like documentation practices
  • Real-world scenarios: designing endpoints for users, orders, and resources across microservices

Quick Start

Design a v1 users API following these guidelines to ensure a consistent, versioned REST interface.

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 endpoints for consistency?▼

REST API design standardizes resource-based URLs using kebab-case and consistent HTTP status codes to reduce integration friction. It applies opinionated rules for resource naming, deterministic error responses, and pagination patterns across microservices.

How do I handle API versioning and error schemas in a microservices architecture?▼

API versioning strategies and error schemas are handled by applying standardized response formats and clear validation patterns across all microservices. This ensures deterministic error responses and interoperable specifications for clients.

What HTTP status codes and pagination patterns should I use for REST resources?▼

REST resources should use consistent status codes and standardized pagination patterns to ensure reliable data retrieval. Implementing deterministic error responses alongside these pagination patterns improves overall developer experience.

Does this API design approach work for idempotent operations and OpenAPI documentation?▼

This API design approach works for idempotent operations and OpenAPI-like documentation practices by enforcing clear validation patterns. It standardizes response formats and ensures interoperable specs across services.

Why does inconsistent resource naming make API integration painful?▼

Inconsistent resource naming makes API integration painful because it leads to unclear error handling and missing versioning strategies. Standardizing REST and HTTP API design reduces this miscommunication and improves developer experience.

Related Skills

Explore More Software Engineering Skills→
michaelsvanbeekmichaelsvanbeek
1

api-design

Define REST API design patterns and contract standards for endpoints and OpenAPI documentation.

Community
Advanced
belokonmbelokonm
8

api-designer

Design REST and GraphQL APIs and generate OpenAPI 3.1 specifications.

Community
Advanced
coreyjacoreyja
6

Backend API

Design and implement RESTful API endpoints with HTTP methods and status codes.

Community
Basic
agulliagulli
482

api-design

Design REST and GraphQL interfaces with resource-based URLs and explicit schemas.

Community
Intermediate