api-design

Define HTTP API contracts with semantic status codes and resource-oriented naming.

Updated Mar 19, 2026
One-click install
npx skills add https://github.com/espensev/ai-skills --skill api-design-espensev
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/espensev/ai-skills/tree/main/codex-skills/skills/api-design
Command: npx skills add https://github.com/espensev/ai-skills --skill api-design-espensev

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Establishing consistent API surfaces that are easy to understand, implement, test, and evolve across a codebase.

Core Features & Use Cases

  • Establish resources with plural naming and clear ownership.
  • Standardize status codes, pagination, and error responses to improve client reliability.
  • Guide versioning, authentication separation, and security considerations for durable APIs.
  • Use cases include designing new endpoints, reviewing existing APIs, and guiding refactors for consistency.

Quick Start

Draft a new endpoint contract by detailing the resource, allowed methods, status codes, and response structure.

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 that scale across services?

To design REST APIs that scale, define resources with plural naming and clear ownership, then apply standard rules for endpoints, semantic status codes, and stable response structures across services. This consistency makes APIs easier to test and evolve.

What is the best way to structure API versioning and authentication for durable HTTP APIs?

The best way to structure API versioning and authentication is to separate security considerations and apply consistent versioning rules across your endpoints. This approach ensures durable APIs by maintaining clear contracts while the underlying services evolve.

How do I standardize error handling and pagination in an API contract?

To standardize error handling and pagination in an API contract, apply design rules that enforce repository conventions for error responses and pagination structures. This improves client reliability by providing predictable and clear resource contracts.

Can I use this approach to review and refactor existing APIs for consistency?

Yes, you can use this API design approach to review existing APIs and guide refactors for consistency. By checking current endpoints against rules for resource-oriented naming and response structures, you can establish a more consistent API surface.

What should I include when drafting a new HTTP API endpoint contract?

When drafting a new HTTP API endpoint contract, you should detail the resource, allowed methods, semantic status codes, and response structure. Defining these elements establishes a clear contract that is easy to implement and test.