Can it update existing OpenAPI files?

Absolutely. One of the core steps in its workflow is writing or updating OpenAPI specifications to ensure your documentation stays in sync with your design.

How does it ensure consistency with my existing code?

The skill gathers requirements directly from your codebase and identifies established patterns to ensure new designs remain consistent with your existing architecture.

Which AI model powers this skill?

This skill is specifically configured to use the Claude 3.5 Sonnet model to provide high-reasoning capabilities for complex architectural design tasks.

Does this skill support both REST and GraphQL?

Yes, the api-design skill is capable of designing and reviewing both RESTful architectures and GraphQL schemas based on your project requirements.

Does it handle error documentation?

Yes, the skill explicitly defines request/response schemas, status codes, and detailed error responses as part of its five-step design process.

API Design & Review

Name: API Design & Review
Author: andrehrferreira

byandrehrferreira

0•

API 개발

Designs and reviews high-quality REST and GraphQL API architectures following industry best practices and OpenAPI standards.

The api-design skill empowers developers to architect robust, scalable APIs by automating the design and review process within Claude Code. It analyzes existing codebase patterns to ensure architectural consistency, defines comprehensive request/response schemas with strict typing, and handles the documentation of error codes and OpenAPI specifications. Whether building a new microservice or refactoring a legacy endpoint, this skill ensures your API follows modern conventions and is ready for production implementation.

주요 기능

01Codebase-aware requirement gathering for pattern consistency

02Comprehensive error response and status code documentation

03OpenAPI (Swagger) specification generation and updates

04REST and GraphQL architectural design and review

050 GitHub stars

06Automated request/response schema definition with strict typing

사용 사례

01Designing new RESTful endpoints for microservices architectures

02Generating and maintaining OpenAPI documentation for legacy codebases

03Reviewing existing GraphQL schemas for consistency and performance

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add andrehrferreira/claude-net api-design

For use in Claude.ai and ChatGPT

주요 기능

01Codebase-aware requirement gathering for pattern consistency

02Comprehensive error response and status code documentation

03OpenAPI (Swagger) specification generation and updates

04REST and GraphQL architectural design and review

050 GitHub stars

06Automated request/response schema definition with strict typing

사용 사례

01Designing new RESTful endpoints for microservices architectures

02Generating and maintaining OpenAPI documentation for legacy codebases

03Reviewing existing GraphQL schemas for consistency and performance

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add andrehrferreira/claude-net api-design

For use in Claude.ai and ChatGPT