api-design

Design REST API patterns for endpoints, contracts, pagination, filtering, and versioning.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

REST API design patterns provide a cohesive blueprint for building consistent, scalable, and maintainable REST APIs by standardizing resource naming, status codes, pagination, filtering, error handling, versioning, and rate limiting.

Core Features & Use Cases

  • Resource naming and URL structure conventions for predictable endpoints across teams.
  • Comprehensive guidance on HTTP methods, status codes, pagination strategies (offset and cursor), filtering, sorting, error formats, and versioning.
  • Versioning, deprecation strategies, authentication patterns, and rate limiting for production APIs.
  • Use cases include designing new endpoints, reviewing API contracts, and building public or partner-facing APIs.

Quick Start

Review an existing API contract and refactor endpoints to align with the design patterns.

Frequently Asked Questions about api-design

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

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

REST API pagination and filtering best practices involve standardizing URL structure conventions, applying offset and cursor pagination strategies, and defining consistent sorting parameters to ensure predictable endpoints across teams.

How do I design consistent error handling and HTTP status codes for a REST API?

Design REST API error handling by enforcing HTTP method semantics, returning appropriate HTTP status codes, and structuring standardized error response formats across all endpoints to provide cohesive and maintainable interfaces.

What is the best way to version a REST API and handle deprecation?

The best way to version a REST API is to apply standardized versioning patterns in the URL or headers, combined with clear deprecation strategies, to maintain backward compatibility while evolving production-grade interfaces.

How do I structure authentication and rate limiting for public REST APIs?

Structure authentication and rate limiting for public REST APIs by implementing standardized authentication patterns and enforcing rate limits to protect production endpoints and ensure scalable, maintainable service consumption.

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

Yes, you can use these REST API design patterns to review existing API contracts by refactoring endpoints to align with resource naming conventions, HTTP method semantics, and standardized status codes.

When should I use cursor pagination instead of offset pagination in REST APIs?

Cursor pagination should be used instead of offset pagination in REST APIs when building production-grade interfaces that require consistent performance across large datasets, as it enforces stable resource retrieval strategies.