skills.rest
DrinkBoooz
DrinkBooozCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Design REST APIs with consistent naming, status codes, pagination, filtering, error responses, versioning, and rate limiting.

Updated Apr 12, 2026
Search Tags:#design#versioning#api#rest#error-handling#pagination#status-codes
One-click install
npx skills add https://github.com/DrinkBoooz/PyTrade --skill api-design-drinkboooz
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/DrinkBoooz/PyTrade/tree/main/.opencode/skills/trading-creation-tool/ecc/skills/api-design
Command: npx skills add https://github.com/DrinkBoooz/PyTrade --skill api-design-drinkboooz

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

REST API design patterns help teams create scalable, maintainable, and predictable APIs, reducing client confusion and integration errors.

Core Features & Use Cases

  • Naming and resource design guidelines for endpoints
  • Standardized status codes, error responses, and versioning strategies
  • Pagination, filtering, and rate limiting patterns for production APIs
  • Use Case: designing a new /api/v1/users endpoint with consistent responses across clients

Quick Start

Draft a simple API contract for a new /api/v1/users endpoint focusing on resource naming and status codes, then extend with pagination and filtering as needed.

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 APIs with consistent resource naming and status codes?▼

Designing REST APIs with consistent resource naming and status codes involves applying standardized HTTP semantics across endpoints. This approach enforces predictable client interactions and reduces integration errors in production systems.

What is the best way to implement pagination and filtering for production APIs?▼

The best way to implement pagination and filtering for production APIs is to apply standardized REST patterns. This ensures endpoints handle large datasets efficiently while maintaining response envelope consistency across multiple client requests.

How should I structure error responses and versioning strategies in a public API?▼

Structuring error responses and versioning strategies in a public API requires enforcing HTTP semantics and response envelope consistency. This approach standardizes error handling and applies practical versioning across different languages and runtimes.

Can I use these REST API patterns to audit existing endpoint contracts?▼

Yes, you can use these REST API patterns to audit existing endpoint contracts. The guidelines enforce HTTP semantics, response envelope consistency, and versioning strategies, making them effective for reviewing and correcting existing public or partner-facing APIs.

Does this approach work for adding rate limiting to partner-facing APIs across multiple runtimes?▼

Yes, this approach works for adding rate limiting to partner-facing APIs across multiple runtimes. It applies production-ready REST patterns including rate limiting, standardized error responses, and versioning strategies across different languages and environments.

Related Skills

Explore More Software Engineering Skills→
nicholasgriffintnnicholasgriffintn
2

backend-design

Plan backend systems, APIs, and data models with structured architecture decisions.

Community
Basic
ChenYCLChenYCL

api-docs

Generate API documentation and OpenAPI 3.0 specs from code or descriptions.

Community
Intermediate
mduongvandinhmduongvandinh
6

gateway-service

Route and secure microservice API traffic with JWT validation and Redis rate limiting.

Community
Advanced
enchantednaturesenchantednatures

api-design

Design standardized REST, GraphQL, and gRPC APIs with versioning and error handling.

Community
Advanced