api-designer

Design RESTful, GraphQL, and gRPC APIs with OpenAPI and Protobuf definitions.

69|5|Updated Nov 16, 2025
One-click install
npx skills add https://github.com/nahisaho/musubi --skill api-designer-nahisaho
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/nahisaho/musubi/tree/main/.claude/skills/api-designer
Command: npx skills add https://github.com/nahisaho/musubi --skill api-designer-nahisaho

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? This Skill simplifies the complex task of designing well-structured, consistent, and documented APIs. It prevents common issues like inconsistent endpoints, poor error handling, and lack of documentation, which hinder developer experience and integration.

Core Features & Use Cases:

  • API Design (REST/GraphQL/gRPC): Defines resources, endpoints, HTTP methods, and data models.
  • OpenAPI Specification Generation: Creates detailed YAML/JSON specifications for RESTful APIs.
  • Authentication & Authorization Design: Recommends and designs security mechanisms like OAuth 2.0 and JWT.
  • Versioning & Error Handling Strategies: Establishes clear guidelines for API evolution and error responses.
  • Use Case: You need to design a new REST API for user management. This Skill can help define endpoints like /users and /users/{id}, specify HTTP methods (GET, POST, PATCH, DELETE), generate a complete OpenAPI 3.x specification, and outline authentication using JWT.

Quick Start: Design a REST API for user management. I need endpoints for creating, reading, updating, and deleting users.

Frequently Asked Questions about api-designer

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I design a REST API with consistent endpoints and documentation?

REST API design involves defining resources, HTTP methods (GET, POST, PATCH, DELETE), and status codes, then generating OpenAPI specifications to document endpoints, parameters, and schemas. This ensures consistency across your API and improves developer experience.

What's the best way to create an OpenAPI specification for my API?

OpenAPI specifications are YAML or JSON documents that formally describe your API's endpoints, request/response schemas, and authentication. Generating a complete OpenAPI 3.x spec ensures API contracts are machine-readable and enables automatic documentation and client generation.

How do I design authentication and authorization for my API?

API authentication design includes choosing mechanisms like OAuth 2.0, JWT, or API keys based on your security requirements. Proper authentication prevents unauthorized access and establishes clear token validation and refresh strategies.

Can I use this Skill to design GraphQL and gRPC APIs, or just REST?

This Skill covers REST, GraphQL, and gRPC API design. Each paradigm has distinct schema definitions—OpenAPI for REST, GraphQL schema language for GraphQL, and Protobuf for gRPC—with corresponding documentation and governance approaches.

What versioning and error handling strategies should my API follow?

API versioning strategies (URL paths, headers, content negotiation) and error handling patterns (consistent status codes, error response schemas) prevent breaking changes and improve client reliability. Clear guidelines establish how your API evolves without disrupting existing consumers.

Do I need OpenAPI documentation if I already have endpoint documentation?

OpenAPI specifications are machine-readable contracts that enable automated documentation, SDK generation, and testing tools beyond human-readable docs. They prevent inconsistencies between documentation and actual implementation.