Does it include rate limiting and security headers?

Yes, it provides standard headers for rate limiting (X-RateLimit) and authentication (Authorization: Bearer) to ensure your API is both secure and performant.

Does it support modern pagination techniques?

Yes, it provides specific patterns for both cursor-based pagination (best for real-time data) and offset-based pagination (best for admin panels).

How does this skill improve API resource naming?

It enforces the use of plural nouns, kebab-case, and shallow URL structures while discouraging verbs in URLs to ensure your API follows strict RESTful conventions.

What versioning strategy does the skill recommend?

The skill recommends URL path versioning (e.g., /api/v1/resource) for its explicitness and routing ease, while providing rules for managing breaking changes.

How are API errors handled by this skill?

It advocates for a standardized, machine-readable JSON error format that includes specific error codes, human-readable messages, and a request_id for traceability.

API Design Standards

Name: API Design Standards
Author: Claude-Code-Community-Ireland

byClaude-Code-Community-Ireland

•

API 개발

Enforces standardized RESTful API design patterns for resource naming, HTTP methods, status codes, and pagination.

This skill provides a comprehensive framework for designing and reviewing high-quality REST APIs within Claude Code. It implements industry best practices for resource naming, correct HTTP method semantics, structured error responses, and robust pagination strategies. By using this skill, developers ensure their APIs are consistent, scalable, and developer-friendly, covering everything from URL structure and versioning to rate limiting and authentication patterns.

주요 기능

01Implementation patterns for cursor-based and offset-based pagination

02Semantic HTTP method mapping for CRUD and complex domain actions

03Comprehensive HTTP status code guidance and structured error response formats

04Best practices for API versioning, rate limiting, and secure authentication

056 GitHub stars

06Standardized RESTful resource naming and URL structure conventions

사용 사례

01Architecting a new REST API with consistent naming and hierarchical structures

02Implementing robust pagination and versioning for high-traffic production APIs

03Conducting automated code reviews to ensure endpoints follow standard status codes and error formats

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add claude-code-community-ireland/claude-code-resources api-design

For use in Claude.ai and ChatGPT

Download Skill