api-design

Standardize REST API naming, status codes, pagination, filtering, versioning, and rate limiting patterns.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/zh667/person-blog --skill api-design-zh667
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/zh667/person-blog/tree/main/.cursor/.agents/skills/api-design
Command: npx skills add https://github.com/zh667/person-blog --skill api-design-zh667

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Standardizes REST API design to reduce integration friction and inconsistencies across teams by providing proven conventions for naming, responses, and versioning.

Core Features & Use Cases

  • Resource naming conventions and URL structure (plural nouns, kebab-case)
  • HTTP methods semantics and status code mappings
  • Pagination, filtering, and sorting guidelines
  • Error response formats and validation patterns
  • API versioning strategies and deprecation practices
  • Rate limiting and authentication considerations

Quick Start

Draft a REST API contract for a new resource following the patterns in this skill.

Frequently Asked Questions about api-design

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

FAQPage Schema
How do I design REST API resource naming and URL structure?

Design REST API resource URLs using plural nouns and kebab-case formatting to maintain consistency. This approach standardizes endpoint paths across production services, reducing integration friction and ensuring predictable resource location during new endpoint design.

What are the best practices for REST API pagination and filtering?

REST API pagination and filtering best practices involve applying standardized strategies for sorting and segmenting resource collections. Implementing consistent pagination patterns prevents payload bloat and ensures efficient data retrieval across large production service datasets.

How should I handle error responses and status codes in REST APIs?

Handle REST API errors by mapping HTTP status codes accurately and using consistent error response envelopes. Standardized error formats and validation patterns provide clear feedback during API integration, contract reviews, and endpoint evolution.

What is the best way to approach REST API versioning and deprecation?

REST API versioning and deprecation require structured approaches to manage endpoint evolution without breaking integrations. Applying proven versioning strategies and deprecation practices allows production services to evolve securely while maintaining backward compatibility.

How do I implement rate limiting and authentication in REST APIs?

Implement REST API rate limiting and authentication by defining clear specifications for access control and request throttling. Establishing these considerations early protects production services from abuse and ensures stable resource availability across integrated clients.

When should I use standardized REST API design patterns for production services?

Use standardized REST API design patterns during new endpoint design, contract reviews, or API evolution across production services. Applying these conventions reduces integration inconsistencies and friction across teams by enforcing requirements for naming, methods, and responses.