skills.rest
AndreaCadonna
AndreaCadonnaCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Standardize REST API endpoint design, versioning, and rate limiting.

Updated Mar 8, 2026
Search Tags:#versioning#rest#rate-limiting#pagination#api-design#http-status-codes
One-click install
npx skills add https://github.com/AndreaCadonna/sbobuz-web-game-app --skill api-design-andreacadonna
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/AndreaCadonna/sbobuz-web-game-app/tree/main/skills/api-design
Command: npx skills add https://github.com/AndreaCadonna/sbobuz-web-game-app --skill api-design-andreacadonna

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

REST API design inconsistencies across teams cause confusing contracts, poor interoperability, and brittle client integrations.

Core Features & Use Cases

  • Consistent resource naming, versioned endpoints, and clear error handling.
  • Pagination, filtering, sorting, and rate limiting patterns for scalable APIs.
  • Use cases: designing new endpoints, reviewing existing contracts, planning versioning, and building public APIs.

Quick Start

Create a new REST API endpoint using kebab-case resource names, appropriate status codes, and add pagination and versioning as defined.

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 design REST APIs for consistent resource naming and versioning?▼

Standardizing REST API design eliminates inconsistencies by enforcing clear resource naming, HTTP method semantics, and versioning strategies. This approach ensures consistent endpoints and robust client integrations across teams.

How do I handle pagination, filtering, and rate limiting when building a REST API?▼

Handle REST API scaling by applying standardized pagination, filtering, sorting, and rate limiting patterns. These mechanisms control data payload sizes and protect server resources from excessive client request volumes.

What HTTP status codes should I use for clear REST API error handling?▼

Use appropriate HTTP status codes to establish clear REST API error handling. Applying correct HTTP method semantics and status codes ensures clients receive accurate response states for successful operations and failures.

Can I use this approach to evaluate existing API contracts and plan versioning?▼

Yes, you can evaluate existing API contracts and plan versioning using standardized REST API design principles. This process identifies inconsistencies in endpoints and behavior to improve interoperability and prevent brittle integrations.

When do I need to implement security considerations and rate limiting in REST API development?▼

Implement security considerations and rate limiting during REST API development when building public APIs or planning scalable services. These patterns protect endpoints from abuse and ensure reliable resource distribution across clients.

Related Skills

Explore More Software Engineering Skills→
mgd34msumgd34msu
4

nuxt

Creates full-stack Nuxt 3 applications with file-based routing and server routes.

Community
Intermediate
hffmnnjhffmnnj
39

api-docs

Generate API reference documentation from OpenAPI specs and GraphQL schemas.

Community
Advanced
raphaelmansuyraphaelmansuy
2

go-api-gateway

...

Community
Advanced
furrycolombia-sysfurrycolombia-sys
1

graphql

Enforce typed GraphQL contracts to prevent data over-fetching and under-fetching.

Community
Intermediate