What API styles does this skill cover?

This skill is specifically optimized for RESTful API design, focusing on resource-based architecture, HTTP semantics, and JSON response patterns.

Can I use this for internal service-to-service communication?

Absolutely. The patterns provided are suitable for both public-facing partner APIs and internal microservices requiring consistent communication standards.

Does it provide code examples for specific frameworks?

Yes, the skill includes implementation patterns for TypeScript (Next.js), Python (Django REST Framework), and Go (net/http).

Does it include guidance on pagination?

Yes, it covers both offset-based pagination for simple use cases and keyset-based (cursor) pagination for high-performance, large-scale datasets.

How does this skill handle API versioning?

It provides a clear strategy for URL path versioning, including deprecation timelines, sunset headers, and distinguishing between breaking and non-breaking changes.

REST API Design Standards

Name: REST API Design Standards
Author: flatrick

byflatrick

0•

API開発

Architects consistent, developer-friendly RESTful APIs using production-proven design patterns and standardized implementation guidelines.

This skill empowers Claude with a comprehensive framework for designing and auditing REST APIs, ensuring they adhere to industry best practices for resource naming, status codes, and scalability. It provides deep domain knowledge on essential topics such as pagination strategies (offset vs. keyset), robust error handling envelopes, and API versioning. By applying these patterns, developers can create professional-grade interfaces that are intuitive for users and maintainable for engineering teams, complete with cross-language implementation examples in TypeScript, Python, and Go.

主な機能

01Standardized resource naming and URL structure guidance using kebab-case and plural nouns

02Comprehensive mapping of HTTP methods and semantic status code usage

03Advanced pagination patterns including scalable cursor-based and simple offset strategies

040 GitHub stars

05Standardized JSON response formats for success, error, and collection envelopes

06Implementation patterns for filtering, sorting, full-text search, and sparse fieldsets

ユースケース

01Reviewing and refactoring existing API contracts to improve developer experience

02Designing new RESTful API endpoints and resource hierarchies from scratch

03Implementing scalable data retrieval systems with consistent pagination and filtering

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add flatrick/mdt api-design

For use in Claude.ai and ChatGPT