Does it include error handling standards?

Yes, it provides standardized JSON error formats and HTTP status code mappings to ensure self-describing, actionable error responses.

Can this skill help generate OpenAPI specifications?

Yes, the skill is designed to help you plan and generate consistent API documentation and OpenAPI/Swagger specifications based on established principles.

Does it support command-line interface design?

Absolutely. It includes a specific CLI API checklist for command structures, flag conventions, and machine-readable output formats like JSON.

How does it ensure backward compatibility?

The skill provides guidance on versioning patterns and safe addition/removal practices to ensure that changes do not break existing consumer integrations.

API Design Architect

Name: API Design Architect
Author: s-hiraoku

bys-hiraoku

0•

API 개발

Architects consistent, well-documented API interfaces across REST, GraphQL, gRPC, and CLI environments.

The API Design Architect skill provides comprehensive guidance for creating professional-grade interfaces by establishing standardized naming conventions, versioning strategies, and error-handling patterns. It assists developers in designing intuitive APIs that prioritize discoverability and backward compatibility, ensuring consistency across various protocols and command-line tools. Whether you are building new endpoints or reviewing existing contracts, this skill helps produce production-ready specifications and documentation.

주요 기능

01Guidance for backward-compatible versioning strategies

02Comprehensive response, error format, and pagination templates

03Standardized resource naming and HTTP method mapping checklists

04Multi-protocol support for REST, GraphQL, gRPC, and CLI interfaces

05CLI command structure and flag convention enforcement

060 GitHub stars

사용 사례

01Standardizing a CLI tool's command structure, flag naming, and machine-readable output

02Designing a new RESTful microservice with consistent resource paths and status codes

03Reviewing existing API contracts to ensure adherence to best practices and naming conventions

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add s-hiraoku/synapse-a2a api-design

For use in Claude.ai and ChatGPT

Download Skill