/api-spec | doc | ClaudePluginHub

Back to Commands

Slash Command

Community

/api-spec

0

Description

Generate OpenAPI specs, interactive API docs, and SDK templates

AI Summary

Generates OpenAPI specs, interactive API docs, and SDK templates with the api-documenter agent.

Install

1

Add the repository(one-time)

$

/plugin marketplace add pproenca/dot-claude-old

2

Install the plugin

$

/plugin install doc@dot-claude

Allowed Tools

TaskReadGlobGrepWriteEditAskUserQuestion

Command Content

API Specification Generation

Generate comprehensive API documentation using the specialized api-documenter agent.

What This Command Does

Dispatches the api-documenter agent to create:

OpenAPI 3.0/3.1 specifications
Interactive API documentation (Swagger UI, Redoc)
SDK templates and code samples
Authentication flow documentation

Before Dispatching

Gather the following from the user:

API Type: REST, GraphQL, WebSocket, or AsyncAPI
Target Audience: Frontend devs, backend devs, third-party integrators
Scope: Single endpoint, module, or entire API
Output Format: OpenAPI spec, interactive docs, SDK stubs, or all

Dispatch the Agent

Use the Task tool to dispatch the api-documenter agent:

Task(
  subagent_type="doc:api-documenter",
  prompt="[Include gathered requirements and any relevant file paths]"
)

When NOT to Use

For parameter lookup tables only → use /doc:reference
For architecture documentation → use /doc:architecture
For step-by-step tutorials → use /doc:tutorial

Links

GitHub Stats

0 forks

Updated 1 month ago