api-designer

Design RESTful and GraphQL APIs with OpenAPI 3.0 specifications.

4|Updated Dec 7, 2025
One-click install
npx skills add https://github.com/icartsh/icartsh_plugin --skill api-designer-icartsh
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: api-designer
Source: https://github.com/icartsh/icartsh_plugin/tree/main/icartsh-plugin/skills/api-designer
Command: npx skills add https://github.com/icartsh/icartsh_plugin --skill api-designer-icartsh

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

This Skill guides API design and documentation, including OpenAPI spec generation and authentication/documentation best practices.

Core Features & Use Cases

  • OpenAPI spec generation: design-first approach with validation
  • GraphQL schema design: type definitions and resolvers planning
  • Auth patterns: OAuth, JWT, API keys, RBAC guidance
  • Documentation as code: quick references and usage patterns

Quick Start

Create an OpenAPI spec with scripts/api_helper.py generate; validate with scripts/api_helper.py validate; build docs with scripts/api_helper.py docs.

Frequently Asked Questions about api-designer

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

FAQPage Schema
How do I generate an OpenAPI specification for my REST API?

OpenAPI specification generation uses a design-first approach to document REST endpoints, request/response schemas, and authentication methods. This Skill provides scripts to generate valid OpenAPI 3.0 specs from your API design, validate them against the standard, and export documentation automatically.

What authentication patterns should I implement for my API?

Authentication patterns include OAuth, JWT tokens, and API keys, each suited to different security contexts. This Skill guides you through selecting and implementing the right scheme—plus role-based access control (RBAC)—and documenting it in your OpenAPI spec for client clarity.

Can I use this for GraphQL API design as well as REST?

Yes. This Skill handles both REST and GraphQL interfaces. For GraphQL, it covers schema design, type definitions, resolver planning, and documentation patterns alongside REST/OpenAPI workflows, so you can design either or both protocols with consistent practices.

How do I document my API so clients can integrate it?

Documentation as code converts your OpenAPI spec into human-readable guides and usage patterns automatically. This Skill generates quick references and integration examples from your spec, reducing manual doc maintenance and keeping examples in sync with schema changes.

What validation does OpenAPI provide for my API design?

OpenAPI validation checks your spec against the 3.0 standard, enforcing correct schema structure, security schemes, pagination rules, error handling patterns, and endpoint definitions. This Skill validates specs before deployment to catch design issues early and ensure client tooling compatibility.

How do I handle API versioning and breaking changes?

Versioning strategies in OpenAPI let you manage backward compatibility and deprecation. This Skill covers planning version schemes in your spec, documenting breaking changes, and maintaining multiple API versions so clients can migrate at their own pace.