import-api-spec

Import and validate OpenAPI, GraphQL, and AsyncAPI specifications into api-reference bundles.

60|2|Updated Jan 26, 2026
One-click install
npx skills add https://github.com/reasondb/reasondb --skill import-api-spec-reasondb
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: import-api-spec
Source: https://github.com/reasondb/reasondb/tree/main/docs/.claude/skills/import-api-spec
Command: npx skills add https://github.com/reasondb/reasondb --skill import-api-spec-reasondb

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Bridge the gap between API specs and publishable docs by importing and validating API specifications.

Core Features & Use Cases

  • Detects spec type (OpenAPI, Swagger, GraphQL, AsyncAPI, Protobuf) and routes to the appropriate doc scaffolding.
  • Validates syntax, resolves $ref references, and extracts servers, security schemes, and error definitions for accurate docs.
  • Generates documentation bundles under api-reference (e.g., introduction, authentication, errors, rate-limiting for OpenAPI; schema.graphql, queries, mutations for GraphQL) ready to publish in docs portals.
  • Use Case: When onboarding a new API, import its spec to auto-create a consistent, versioned docs surface.

Quick Start

Import your API spec (OpenAPI, GraphQL, or AsyncAPI) into the importer to generate a ready-to-publish api-reference bundle.

Frequently Asked Questions about import-api-spec

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

FAQPage Schema
How do I import an OpenAPI spec and generate publishable API documentation?

To import an OpenAPI spec, provide the specification file to validate syntax and resolve $ref references, generating a structured api-reference bundle with introduction, authentication, errors, and rate-limiting pages ready to publish.

Can I generate separate documentation bundles for GraphQL and AsyncAPI specifications?

Yes, you can generate documentation bundles for GraphQL and AsyncAPI specifications. The tool detects the spec type and routes it to appropriate scaffolding, creating schema.graphql, queries, and mutations for GraphQL.

Does the API spec importer automatically resolve $ref references and extract security schemes?

Yes, the API spec importer automatically resolves $ref references and extracts servers, security schemes, and error definitions during syntax validation to ensure accurate documentation generation across multiple spec versions and formats.

What is the best way to automate API spec ingestion for a documentation pipeline?

The best way to automate API spec ingestion is to route your OpenAPI, GraphQL, or AsyncAPI files through automatic spec detection and validation, outputting a structured, versioned api-reference bundle directly into your documentation portal.

How do I validate syntax and detect the type of an unknown API specification file?

You can validate syntax and detect the spec type of an unknown API specification file by feeding it into the importer, which automatically identifies formats like OpenAPI, Swagger, GraphQL, AsyncAPI, and Protobuf before routing.

Do I need to manually structure my API reference docs after importing a Swagger or AsyncAPI spec?

No, you do not need to manually structure API reference docs. The importer automatically generates a ready-to-publish documentation bundle with relevant sections like introduction, authentication, and errors directly from your Swagger or AsyncAPI spec.