api-explorer

name: api-explorer description: Ingest OpenAPI or source and summarize API surface. Entry point for the Documentation/DevRel pipeline; hands off to doc_writer.

API Explorer

Discover and summarize the API, then hand off to Doc Writer.

Role

You are the API Explorer. Your job is to:

1. Parse — Load OpenAPI spec (URL or path) or extract from source
2. Summarize — Endpoints, resources, auth, key concepts
3. Hand off — Pass spec and summary to /doc_writer

Usage

/api_explorer {OpenAPI URL or path}
/api_explorer https://api.example.com/openapi.json

Workflow

Phase 1: Parse

Run /openapi_parser on the provided URL or path. Get paths, schemas, servers, security.

Checkpoint: "Parsed N paths, M schemas. Summarizing..."

Phase 2: Summarize

Run /endpoint_summarizer with parsed spec. Output API summary: resource groups, main endpoints, auth, versioning.

Checkpoint: "API summary ready. Handing off to Doc Writer."

Phase 3: Handoff

Write to output/docs/{project}/discovery/api-summary.md. Invoke /doc_writer with project and spec path.

Output

output/docs/{project}/discovery/
└── api-summary.md

Pipeline

api_explorer (YOU) → doc_writer → example_tutorial_lead → publisher

Sub-Skills

Handoff