skills.rest
fideguch
fideguchCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Designs REST API patterns including pagination, filtering, error responses, and versioning for production services.

1|Updated Jan 30, 2021
Search Tags:#design#versioning#api#rest#error-handling#pagination#naming
One-click install
npx skills add https://github.com/fideguch/my_dotfiles --skill api-design-fideguch
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/fideguch/my_dotfiles/tree/main/claude/skills/api-design
Command: npx skills add https://github.com/fideguch/my_dotfiles --skill api-design-fideguch

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Establishing consistent REST API design patterns to reduce integration friction, improve interoperability, and speed up API contracts across teams.

Core Features & Use Cases

  • Resource naming, URL structure, and versioning conventions for stable, evolvable APIs.
  • Standardized HTTP methods, status codes, error handling, and response formats for predictable client behavior.
  • Pagination, filtering, and sorting strategies to support scalable data access and rich query capabilities.
  • Use cases include designing new endpoints, auditing existing contracts, and implementing production-grade API design.

Quick Start

Draft a REST API design for a new endpoint using the patterns described above.

Frequently Asked Questions about api-design

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

FAQPage Schema
What are the best REST API design patterns for consistent contracts across teams?▼

REST API design patterns for consistent contracts enforce URL naming conventions, HTTP method semantics, and standard status codes to reduce integration friction and improve interoperability across teams.

How do I design pagination and filtering strategies for scalable REST APIs?▼

Design scalable REST APIs by implementing pagination, filtering, and sorting strategies that support scalable data access and rich query capabilities for predictable client behavior.

How should I structure error responses and status codes in REST API design?▼

REST API error handling standardizes HTTP status codes and response formats to ensure predictable client behavior during endpoint creation, design reviews, and API modernization.

What versioning conventions should I use for evolvable REST API endpoints?▼

REST API versioning conventions apply resource naming and URL structure patterns during endpoint creation to ensure stable, evolvable APIs for production services.

Can I use this to audit existing REST API contracts for naming and response consistency?▼

Auditing existing REST API contracts checks URL naming conventions, HTTP method semantics, and standardized responses to apply scalable design practices during API design reviews.

Related Skills

Explore More Software Engineering Skills→
musujmusuj

phase-1-schema

Define project terminology, entities, relationships, and data structures.

Community
Intermediate
686f6c61686f6c61
105

api-docs

Generate API documentation with HTTP methods, routes, parameters, and schemas.

Community
Intermediate
garochee33garochee33
3

api-gateway-designer

Design API gateway patterns for REST, GraphQL, WebSocket, and microservice routing.

Community
Advanced
elmochilyaselmochilyas
8

laravel-api-grpc

Implement gRPC in Laravel 13 microservices using Protocol Buffers and RoadRunner.

Community
Advanced