api-design

Design RESTful APIs with consistent naming, versioning, and error handling.

Updated Apr 14, 2026
One-click install
npx skills add https://github.com/JuanDiego30/cermont_aplicativo --skill api-design-juandiego30
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/JuanDiego30/cermont_aplicativo/tree/main/.agents/skills/api-design
Command: npx skills add https://github.com/JuanDiego30/cermont_aplicativo --skill api-design-juandiego30

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

REST API design inconsistencies and unclear error handling can slow development and degrade integration. This Skill consolidates patterns for resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting to improve consistency, safety, and maintainability.

Core Features & Use Cases

  • Resource URL design using nouns, pluralization, and nested relationships
  • HTTP methods and status code guidance for common operations
  • Pagination strategies (offset and cursor) with examples
  • Filtering, sorting, and full-text search conventions
  • Standardized error formats and versioning/deprecation guidance
  • Rate limiting strategies for public and internal APIs
  • Examples for admin dashboards and public APIs

Quick Start

Define endpoints following the conventions above, starting with a versioned path like /api/v1/items to apply the guidance immediately.

Frequently Asked Questions about api-design

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

FAQPage Schema
What is the best way to structure REST API resource URLs and naming conventions?

REST API resource naming should use noun-based endpoints, pluralization, and nested relationships to represent data. This approach enforces consistent URL structure and reduces integration friction by standardizing how resources are accessed and manipulated.

How do I handle REST API pagination, filtering, and sorting for large datasets?

REST API pagination can be implemented using offset or cursor strategies to manage large datasets. Filtering, sorting, and full-text search conventions should follow standardized query parameters to ensure consistent data retrieval across endpoints.

How do I design standardized error responses and use HTTP status codes in a REST API?

Error responses in a REST API should use a standardized format paired with appropriate HTTP status codes for common operations. This clear error handling strategy reduces integration friction and improves developer productivity by providing predictable failure modes.

What are the best REST API versioning and deprecation strategies for production?

REST API versioning uses a versioned path like /api/v1/items to manage changes without breaking existing integrations. Following clear deprecation guidance and versioning strategies ensures maintainability and safety across production APIs.

How do I implement rate limiting for public and internal REST APIs?

Rate limiting for public and internal REST APIs controls traffic by restricting the number of requests a client can make. Implementing rate limiting strategies protects backend services from abuse and ensures fair resource allocation across consumers.

When should I use cursor pagination versus offset pagination in a REST API?

Cursor pagination is preferred for large, frequently updated REST API datasets to avoid skipping records, while offset pagination suits smaller, static datasets. Choosing the correct pagination strategy improves performance and data consistency.