Can I use this for internal class interfaces?

No, this skill is specifically designed for networked APIs (HTTP/GraphQL) rather than internal software library interfaces or CLI tools.

How does it handle API versioning?

The skill provides guidance on multiple versioning strategies, recommending URL versioning as the primary approach for clarity and visibility.

Does this skill help with both REST and GraphQL?

Yes, it provides specific conventions for RESTful resource management and specialized best practices for GraphQL schema design and performance.

Does it include security recommendations?

Yes, it features a comprehensive security checklist covering HTTPS, input validation, rate limiting, and authentication flows like OAuth 2.0.

API Design Best Practices

Name: API Design Best Practices
Author: Zate

byZate

0•

API 개발

Standardizes the creation and review of RESTful and GraphQL APIs using industry-proven design patterns and conventions.

This skill provides Claude with a comprehensive framework for designing clean, consistent, and developer-friendly APIs. It covers essential architectural decisions including resource naming, versioning strategies, and HTTP method selection, alongside advanced patterns for pagination, filtering, and error handling. By incorporating a dedicated security checklist and documentation standards like OpenAPI, this skill ensures that backend interfaces are not only functional but also secure and easy for other developers to consume.

주요 기능

01Comprehensive HTTP status code mapping and consistent request/response formats

02Integrated API security checklist and OpenAPI documentation standards

03Standardized RESTful URL structures and hierarchical resource naming conventions

04Advanced pagination patterns including offset, cursor, and keyset strategies

050 GitHub stars

06GraphQL optimization techniques and N+1 problem prevention strategies

사용 사례

01Architecting complex data relationships using GraphQL best practices

02Reviewing existing API endpoints to identify and remediate design anti-patterns

03Designing a new microservice API from scratch to ensure architectural consistency

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add zate/cc-plugins api-design

For use in Claude.ai and ChatGPT

Download Skill