rest-api-design

Design and review REST APIs with resource modeling and HTTP semantics.

1|Updated Jan 4, 2026

Search Tags:#versioning #rest #http #error-handling #idempotency #pagination #api-design

Ready to run

npx skills add https://github.com/karchtho/my-claude-marketplace --skill rest-api-design-karchtho

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: rest-api-design
Source: https://github.com/karchtho/my-claude-marketplace/tree/main/bundles/api-design-bundle/skills/rest-api-design
Command: npx skills add https://github.com/karchtho/my-claude-marketplace --skill rest-api-design-karchtho

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill provides a cohesive framework for designing, reviewing, and enforcing REST API design standards to improve consistency, usability, and scalability across services.

Core Features & Use Cases

Resource-oriented design guidance that maps nouns to endpoints and uses HTTP methods for actions
Patterns for pagination, filtering, error handling, and versioning across APIs
Use cases include designing new endpoints, refactoring existing APIs, and enforcing team-wide API design standards

Quick Start

Create a REST API design brief by listing resources, endpoints, HTTP methods, and response schemas for your service.

Frequently Asked Questions about rest-api-design

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

FAQPage Schema

How do I design REST APIs with consistent resource modeling and HTTP semantics?▼

Design REST APIs by mapping nouns to endpoints and using HTTP methods for actions. This approach enforces resource-oriented design, proper method usage, and standardized status codes to improve consistency and usability across services.

What patterns should I use for pagination, filtering, and error handling in REST API design?▼

Use standardized patterns for pagination, filtering, and error handling to establish consistency across APIs. Applying these patterns ensures predictable behavior when designing new endpoints or refactoring existing API services.

What is the best way to implement versioning strategies and OpenAPI documentation for REST endpoints?▼

Implement versioning strategies and OpenAPI documentation by enforcing clear naming conventions and resource-oriented design standards. This provides a cohesive framework that improves scalability and maintainability across team-wide REST API services.

Can I use this REST API design framework to establish team-wide design standards across multiple services?▼

Yes, you can enforce team-wide REST API design standards across multiple services. It provides a cohesive framework for reviewing APIs, ensuring consistent resource modeling, HTTP semantics, and security considerations for architects and software engineers.

How do I start creating a REST API design brief for a new service?▼

Create a REST API design brief by listing resources, endpoints, HTTP methods, and response schemas for your service. This quick start approach maps directly to resource-oriented design principles and standardized status codes.

Why does my REST API design lack consistency in security considerations and naming conventions?▼

REST API design lacks consistency when team-wide standards are not enforced. Applying a cohesive framework with clear naming conventions, standardized status codes, and security considerations resolves usability and scalability issues across services.