api-design

Design REST API conventions for resource naming, HTTP methods, and pagination.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Reduce inconsistent, confusing, and fragile REST APIs by providing clear conventions for resource naming, HTTP semantics, response formats, and operational controls so teams deliver predictable, developer-friendly endpoints.

Core Features & Use Cases

  • Resource naming & URL structure: guidance on plural nouns, kebab-case, and when to use nested resources or action endpoints.
  • HTTP method semantics & status codes: rules for idempotency, correct success and error codes, and structured error payloads.
  • Pagination, filtering, auth, rate limiting & versioning: strategies for offset vs cursor pagination, filter/sort conventions, token-based auth patterns, rate-limit headers, and version deprecation timelines.
  • Use Case: Standardize a public users and orders API with cursor pagination, consistent error envelopes, auth requirements, and a deprecation plan for breaking changes.

Quick Start

Use the api-design skill to review and standardize a new users API so endpoints use plural kebab-case, correct HTTP methods and status codes, a consistent response envelope, cursor pagination for lists, and appropriate rate-limit and versioning headers.

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 consistent REST API with proper resource naming and HTTP status codes?

Design a consistent REST API by enforcing plural kebab-case resource naming, correct HTTP method semantics, and structured response envelopes. This ensures predictable, developer-friendly endpoints with clear idempotency rules and accurate success or error status codes.

What's the best way to implement pagination and filtering for a public REST API?

The best way to implement pagination and filtering is applying cursor pagination for large lists and standard filter or sort conventions. This approach prevents performance bottlenecks and provides stable response payloads for public-facing REST APIs.

How do I structure error handling and rate limiting headers for production REST APIs?

Structure error handling by returning consistent error envelopes with appropriate HTTP status codes. Configure rate limiting by adding standard rate-limit headers to control traffic and protect production REST API endpoints from abuse.

When do I need a versioning policy for my REST API and how do I manage breaking changes?

You need a versioning policy for your REST API when introducing breaking changes to public or partner-facing endpoints. Establish version deprecation timelines to manage transitions smoothly while maintaining backward compatibility for existing clients.

Can I use this REST API design approach for partner-facing services with token-based authentication?

Yes, you can apply this approach to partner-facing services using token-based authentication patterns. It standardizes authentication requirements, rate limiting, and response formats to ensure reliable integration for external partners.