api-design

Design REST API contracts with resource naming, HTTP semantics, and response patterns.

Updated May 14, 2026
One-click install
npx skills add https://github.com/WUIX69/e-lock --skill api-design-wuix69
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/WUIX69/e-lock/tree/main/.agent/.agents/skills/api-design
Command: npx skills add https://github.com/WUIX69/e-lock --skill api-design-wuix69

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you design clear, consistent REST APIs that are easier for clients to use, safer to evolve, and simpler to maintain in production.

Core Features & Use Cases

  • Resource Naming: Define clean, plural, kebab-case endpoint structures with sensible nesting for related resources.
  • HTTP Semantics: Choose the right methods and status codes for reads, writes, validation failures, conflicts, and deletions.
  • Response Design: Standardize success envelopes, error payloads, pagination metadata, filtering, sorting, and sparse fieldsets.
  • Production Concerns: Plan authentication, authorization, rate limiting, and versioning without breaking existing clients.
  • Use Case: Review a draft endpoint set for a web app and turn it into a production-ready API contract with predictable behavior.

Quick Start

Ask for a review of your API draft and have the skill return a production-ready endpoint structure, status codes, error format, pagination strategy, and versioning guidance.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design a REST API with proper pagination, filtering, and sorting?

Designing a REST API with pagination, filtering, and sorting requires standardizing response envelopes, pagination metadata, and sparse fieldsets to ensure clients can query resources predictably and safely.

What HTTP status codes should I use for REST API validation failures and conflicts?

REST API validation failures and conflicts require choosing correct HTTP semantics for reads, writes, and deletions, applying safety-focused status code handling to standardize error payloads and client responses.

How do I structure REST API endpoints for nested resources?

Structuring REST API endpoints for nested resources involves resource-oriented URL naming using clean, plural, kebab-case structures with sensible nesting for related resources to maintain consistency.

What is the best way to version a REST API without breaking existing clients?

Versioning a REST API without breaking existing clients involves planning versioning strategies alongside authentication, authorization, and rate limiting to ensure safe evolution and production readiness.

Can I use this to review an existing REST API draft for production readiness?

Reviewing an existing REST API draft for production readiness involves turning endpoint sets into predictable contracts with standardized response patterns, error handling, and correct HTTP semantics.

Why does my REST API need a standardized error payload format?

A standardized REST API error payload format is needed to standardize response envelopes, ensuring safer API evolution, consistent client error handling, and simpler maintenance in production.