api-design

Design and enforce REST API patterns for naming, status codes, pagination, and versioning.

Updated Apr 25, 2026
One-click install
npx skills add https://github.com/ldk-hub/broke-shopping --skill api-design-ldk-hub
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/ldk-hub/broke-shopping/tree/main/.agent/.agents/skills/api-design
Command: npx skills add https://github.com/ldk-hub/broke-shopping --skill api-design-ldk-hub

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

REST API design patterns for consistent resource naming, status codes, pagination, filtering, error responses, versioning, and rate limiting.

Core Features & Use Cases

  • URL Structure conventions, naming rules, HTTP methods and status codes, and standardized response formats.
  • Pagination, filtering, sorting, and search patterns across endpoints to support scalable APIs.
  • Versioning and authentication/authorization strategies for public, partner, and internal APIs.
  • Use case: Audit and design new endpoints with consistent contracts across teams.

Quick Start

Design or evaluate REST APIs by applying the patterns in this guide to a new or existing endpoint.

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 URL structures and naming conventions for resources?

Design REST API URL structures by applying standardized patterns for resource naming, HTTP methods, and status codes. This enforces consistent response formats and exacting requirements for endpoint names across public, partner, and internal services.

What is the best way to implement pagination, filtering, and sorting across scalable REST APIs?

Implement REST API pagination, filtering, sorting, and search by applying standardized patterns across endpoints. This supports scalable APIs by enforcing consistent query parameter structures and response formats for large data sets.

How do I handle REST API error responses and status codes consistently?

Handle REST API errors by enforcing standardized response formats and exacting requirements for HTTP status codes. This ensures consistent error contracts across teams when building new endpoints or auditing existing services.

Does this approach support REST API versioning and authentication strategies for partner APIs?

Yes, this approach supports REST API versioning and authentication strategies tailored for public, partner, and internal APIs. It enforces specific policies for versioning strategies and rate-limiting to secure and manage service access.

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

Yes, you can use these REST API design patterns to audit existing endpoint contracts. The standardized rules for URL structures, HTTP methods, and response formats help evaluate and enforce consistency across existing services.

What are the limitations of using standardized REST API design patterns for rate limiting?

Standardized REST API design patterns enforce rate-limiting policies and authentication rules, but limitations arise when applying generic URL structures to highly specialized non-REST architectures. These patterns focus strictly on HTTP methods and resource naming.