api-design

Design and review REST API interfaces with consistent naming, status codes, and versioning.

Updated Apr 6, 2026
One-click install
npx skills add https://github.com/a2mus/ecc-antigravity --skill api-design-a2mus
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/a2mus/ecc-antigravity/tree/main/skills/api-design
Command: npx skills add https://github.com/a2mus/ecc-antigravity --skill api-design-a2mus

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

REST API design patterns help teams standardize endpoints, status codes, versioning, and data contracts to reduce integration friction and maintenance cost.

Core Features & Use Cases

  • Resource naming conventions, consistent HTTP methods, predictable pagination, and standardized error responses.
  • Use Case: Designing new endpoints and reviewing existing contracts to ensure alignment with versioning and error formats.

Quick Start

Create a new endpoint following the naming and status-code guidelines and validate responses against the standard shapes.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design consistent REST API endpoints and naming conventions?▼

To design REST API endpoints, follow structured guidance for resource naming, consistent HTTP methods, and standardized error responses to reduce integration friction. This ensures predictable resource naming and HTTP semantics across services.

What HTTP status codes and error formats should I use for my REST API?▼

Standardized error responses and HTTP status codes enforce predictable REST API contracts. Use structured guidance to align error formats and status codes across services, ensuring consistent HTTP semantics for clients.

How do I implement pagination and filtering in a REST API?▼

Implement REST API pagination and filtering by validating responses against standard shapes and applying predictable pagination guidelines. This standardizes data contracts and reduces maintenance costs across endpoints.

What is the best way to handle REST API versioning and rate limiting?▼

REST API versioning and rate limiting are handled through structured guidance that enforces standards across services. Review existing contracts to ensure alignment with versioning strategies and rate limiting rules.

Can I review existing API contracts to ensure they meet naming and status code standards?▼

Yes, you can review existing REST API contracts to ensure alignment with versioning, resource naming, and error formats. This validates responses against standard shapes and enforces HTTP semantics.

Why do I need standardized data contracts for my REST API?▼

Standardized data contracts reduce integration friction and maintenance costs by enforcing consistent resource naming, predictable pagination, and standardized error responses across all REST API endpoints.