skills.rest
handsomelong922
handsomelong922COMMUNITY
Explore all skills by this author →
GitHub

api-design

Design REST API contracts with resource naming, pagination, versioning, and error handling.

Updated Apr 3, 2026
Search Tags:#versioning#security#rest#http#error-handling#pagination#api-design
One-click install
npx skills add https://github.com/handsomelong922/my-codex-skills --skill api-design-handsomelong922
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/handsomelong922/my-codex-skills/tree/main/skills/api-design
Command: npx skills add https://github.com/handsomelong922/my-codex-skills --skill api-design-handsomelong922

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

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

Core Features & Use Cases

  • Resource Design: consistent URL structures, pluralized nouns, and flat resource hierarchies.
  • HTTP Semantics: correct method usage, status codes, and standardized error responses.
  • Pagination, Filtering & Sorting: support for offset and cursor pagination, filtering queries, and sorting directives.
  • Versioning & Lifecycle: strategies for API versioning, deprecation, and clean upgrades.
  • Implementation Guidance: patterns across TypeScript, Python, and Go for practical adoption.

Quick Start

Design a REST API for a catalog service that supports resource naming, pagination, filtering, versioning, and robust error handling.

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 resource naming and URL structure?▼

REST API pagination strategies include offset and cursor pagination to manage large datasets. Offset pagination is simpler for static data, while cursor pagination handles frequent real-time changes more efficiently without missing records.

How do I implement cursor pagination vs offset pagination in REST APIs?▼

REST API pagination strategies include offset and cursor pagination to manage large datasets. Offset pagination is simpler for static data, while cursor pagination handles frequent real-time changes efficiently without missing records during traversal.

How do I design robust error handling and HTTP status codes for REST APIs?▼

Robust REST API error handling requires using correct HTTP semantics and standardized error responses. This means returning appropriate HTTP status codes and consistent error payloads to help clients diagnose and recover from failures effectively.

What is the best strategy for REST API versioning and deprecation?▼

REST API versioning strategies manage lifecycle changes through structured versioning and deprecation policies. This enables clean upgrades and backward compatibility while guiding clients smoothly through endpoint transitions without breaking existing integrations.

Does REST API design guidance work with TypeScript, Python, and Go?▼

Yes, REST API design guidance includes implementation patterns across TypeScript, Python, and Go. This provides practical adoption steps for resource design, filtering, and security considerations tailored to each specific language environment.

Related Skills

Explore More Software Engineering Skills→
Adelie-SquadAdelie-Squad
17

api-developer

Design API contracts and generate OpenAPI 3.0 documentation.

Official
Advanced
dinoudondinoudon

api-documentation

Generates API references and SDK scaffolds from OpenAPI specifications.

Community
Advanced
vertivolatamvertivolatam
1

API Gateway & Rate Limiting

Implement API Gateways with Kong and Nginx rate limiting strategies.

Official
Advanced
HeldinhowHeldinhow
4

grpc-microservices

Enable gRPC communication between microservices using Protocol Buffers.

Community
Advanced