What is the recommended approach for idempotent updates?

The skill suggests using PUT and DELETE for idempotent operations and the Pair pattern to distinguish between new and existing resources.

How does this skill handle API versioning?

It implements URL path versioning (e.g., /api/v1/) to manage breaking changes while supporting legacy versions during migrations.

What pagination pattern does it recommend?

It uses a structured response object containing the data array and a pagination metadata object with page, pageSize, and total counts.

Does this skill include security best practices?

Yes, it enforces input validation at the boundary, authorization in the service layer, and rate-limiting for public endpoints.

REST API Design

Name: REST API Design
Author: AndVl1

byAndVl1

•

API 개발

Architects robust RESTful APIs using standardized URL structures, status codes, and professional data patterns.

The API Design skill serves as a comprehensive blueprint for creating production-grade RESTful services within Claude Code. It provides standardized patterns for resource-oriented URL structures, correct HTTP status code usage, and consistent JSON response schemas for collections and errors. By implementing best practices for query parameters, idempotency, and versioning, this skill ensures that your backend architecture remains scalable, predictable, and secure from the first endpoint to the final deployment.

주요 기능

01Advanced query parameter conventions for filtering, sorting, and searching

02Standardized URL path patterns for nested and top-level resources

031 GitHub stars

04Security-focused design guidelines for input validation and authorization

05Comprehensive mapping of HTTP status codes for all request outcomes

06Consistent response schemas for pagination, resources, and validation errors

사용 사례

01Implementing standardized pagination and filtering for large data collections

02Refactoring existing endpoints to follow idempotent and secure REST principles

03Designing a new microservice architecture with consistent resource paths

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add andvl1/claude-plugin api-design

For use in Claude.ai and ChatGPT

Download Skill