skills.rest
emiled16
emiled16COMMUNITY
Explore all skills by this author →
GitHub

api-design

Designs REST API contracts covering endpoints, resources, pagination, authentication, versioning, and rate limiting.

Updated Mar 27, 2026
Search Tags:#versioning#error handling#rate limiting#rest api#pagination#endpoint design#http status codes
One-click install
npx skills add https://github.com/emiled16/close-to-me --skill api-design-emiled16
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/emiled16/close-to-me/tree/main/.codex/skills/api-design
Command: npx skills add https://github.com/emiled16/close-to-me --skill api-design-emiled16

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you design REST APIs that are consistent, predictable, and easy for developers to use, reducing contract drift and avoidable implementation mistakes.

Core Features & Use Cases

  • Resource and URL Design: Choose plural nouns, kebab-case paths, and sensible nesting for related resources.
  • Status Codes and Error Handling: Apply HTTP semantics correctly with structured success and error responses.
  • Pagination, Filtering, and Sorting: Shape list endpoints for small admin views, public APIs, and high-volume feeds.
  • Use Case: A product team can use this Skill to review a new endpoint set before launch and ensure naming, auth, versioning, and rate limiting are production-ready.

Quick Start

Use the api-design skill to review your API endpoints for naming, status codes, authentication, pagination, and versioning consistency.

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 endpoints with consistent naming and resource modeling?▼

Design REST API endpoints by using plural nouns, kebab-case paths, and sensible nesting for related resources to ensure consistent naming and logical resource modeling that improves usability.

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

Use semantic HTTP status codes for REST API error handling by applying HTTP semantics correctly with structured success and error responses to ensure predictable client behavior.

How do I implement pagination, filtering, and sorting for high-volume REST API list endpoints?▼

Implement pagination, filtering, and sorting for REST API list endpoints by shaping list responses to handle small admin views, public APIs, and high-volume feeds efficiently.

What's the best way to version REST APIs and apply rate limiting rules?▼

Version REST APIs and apply rate limiting by establishing stable versioning schemes and clear authorization rules to satisfy production requirements and prevent contract drift.

Can I use this to review my existing API endpoints before a production launch?▼

Yes, you can review existing API endpoints before launch to ensure naming, authentication, versioning, and rate limiting configurations are production-ready and free of contract drift.

Related Skills

Explore More Software Engineering Skills→
Fr-e-dFr-e-d
157

architecture-extract

Analyze project directory structures to generate architectural summaries.

Community
Basic
curiositechcuriositech
181

openapi-spec-writer

Generate OpenAPI 3.0/3.1 YAML or JSON specifications for REST APIs.

Official
Advanced
cenjiecenjie

api-security-hardening

Secure REST APIs with authentication, rate limiting, CORS, and input validation.

Community
Advanced
Camilo8902Camilo8902

rest-to-graphql-migrator

Migrate REST APIs to GraphQL incrementally using schema stitching and REST data source wrappers.

Community
Advanced