Verified:GitHub

api-design-guide

Codify RESTful API design best practices for resource modeling, URLs, HTTP methods, pagination, filtering, versioning, and error handling.

Updated Jan 23, 2026

Search Tags:#versioning #rest #design-principles #error-handling #api-design #http-methods

Ready to run

npx skills add https://github.com/Gdm0714/claude-code-resource --skill api-design-guide

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: api-design-guide
Source: https://github.com/Gdm0714/claude-code-resource/tree/main/skills/api-design-guide
Command: npx skills add https://github.com/Gdm0714/claude-code-resource --skill api-design-guide

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

RESTful API 설계의 복잡성을 줄이고, 직관적이고 일관된 API 설계를 촉진합니다.

Core Features & Use Cases

일관된 URL 설계 원칙, HTTP 메서드의 명확한 매핑, 강력한 에러 처리, 버전 관리의 확장성.
사용 사례: 사용자, 상품, 주문 등의 리소스에 대한 예측 가능한 엔드포인트를 설계하고 페이지네이션, 필터링, 중첩 리소스를 적용합니다.

Quick Start

Design a RESTful API for a basic e-commerce app with users, products, and orders following these principles.

Frequently Asked Questions about api-design-guide

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

FAQPage Schema

What are the key REST API design principles for consistent URL structures and HTTP methods?▼

REST API design principles map resource modeling to predictable URL structures and apply standard HTTP methods like GET, POST, PUT, and DELETE for intuitive endpoint behavior. This ensures consistent resource naming, clear action mapping, and predictable interactions across typical API scenarios.

How do I handle errors and versioning in a RESTful API?▼

Error handling and versioning in a RESTful API require structured error responses and scalable versioning strategies to manage changes. Applying these guidelines ensures robust error reporting and backward-compatible API evolution without disrupting existing consumers.

What is the best way to design pagination and filtering for nested REST resources?▼

Designing pagination and filtering for nested REST resources involves applying consistent query parameters to manage large datasets and retrieve specific subsets. This approach maintains predictable endpoint behavior across complex resource hierarchies like users, products, and orders.

Can I apply these REST API guidelines to an e-commerce application with users, products, and orders?▼

These REST API guidelines apply directly to an e-commerce application by structuring users, products, and orders as predictable endpoints. You can implement resource modeling, pagination, filtering, and nested resources to build an intuitive and consistent API.

When should I use PUT versus PATCH for resource updates in REST API design?▼

Using PUT versus PATCH in REST API design depends on whether you are replacing a full resource or applying partial modifications. Following standard HTTP method usage guidelines ensures predictable and intuitive state transitions for API consumers.