skills.rest
BinyaminEden
BinyaminEdenCOMMUNITY
Explore all skills by this author →
GitHub

api-design

Standardize REST API endpoint design, versioning, and error responses.

26|1|Updated Mar 19, 2026
Search Tags:#error handling#api design#rest api#pagination#api versioning#api best practices#endpoint conventions
One-click install
npx skills add https://github.com/BinyaminEden/claude-combine --skill api-design-binyamineden
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: api-design
Source: https://github.com/BinyaminEden/claude-combine/tree/main/skills/api-design
Command: npx skills add https://github.com/BinyaminEden/claude-combine --skill api-design-binyamineden

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Building inconsistent, non-standard REST APIs leads to poor developer experience, integration failures, and unexpected production bugs when endpoints deviate from expected conventions.

Core Features & Use Cases

  • Standardized Conventions: Provides clear rules for resource naming, HTTP method usage, and status code selection to ensure all endpoints follow consistent, widely accepted patterns.
  • Scalable API Patterns: Includes proven implementations for pagination, filtering, sorting, error handling, authentication, rate limiting, and versioning to support APIs of any size.
  • Use Case Example: When building a new e-commerce order API, use this skill to ensure all endpoints use plural kebab-case resource names, return semantically correct status codes, and implement cursor-based pagination for large order lists.

Quick Start

Use the api-design skill to review your existing /api/v1/users endpoint and identify any deviations from REST best practices for naming, status codes, and error response formatting.

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 endpoint conventions?▼

REST API design best practices dictate using plural kebab-case for resource names to ensure endpoint conventions are consistent. This standardization eliminates integration failures and improves developer experience across public, partner, and internal APIs.

How do I implement pagination and filtering for large REST API endpoints?▼

Implement scalable REST API patterns like cursor-based pagination to handle large lists efficiently. Applying standardized pagination, filtering, and sorting mechanisms ensures your endpoints support datasets of any size without performance degradation.

How do I format consistent error handling and HTTP status codes in my API?▼

Consistent error handling requires selecting semantically correct HTTP status codes and returning standardized error response formatting. Following these API design rules prevents unexpected production bugs and provides clear integration feedback.

What is the best way to plan an API versioning strategy for public and internal APIs?▼

An effective API versioning strategy standardizes endpoint contracts across public, partner, and internal APIs. Planning versioning correctly during the API design stage prevents breaking changes and ensures long-term scalability.

How do I review an existing REST API endpoint for best practice deviations?▼

Review existing REST API endpoints by checking resource naming, HTTP method usage, and status code selection against established conventions. Identifying deviations in authentication, rate limiting, and error formatting ensures consistent integration.

Related Skills

Explore More Software Engineering Skills→
k1lgork1lgor
2

api-designer

Standardize REST and GraphQL API designs with routes, schemas, and OpenAPI specifications.

Community
Intermediate
lsst-sqrelsst-sqre
2

testing-infrastructure

Configure Vitest, React Testing Library, and MSW mocks for monorepo CI testing.

Official
Intermediate
boomNDSboomNDS

api-security-best-practices

Apply authentication, authorization, input validation, and rate limiting patterns to secure APIs.

Community
Advanced
davidrrowleydavidrrowley

api-design

Design and validate REST, GraphQL, and gRPC API contracts with OpenAPI schemas.

Community
Advanced