import-api-spec

Validate and convert OpenAPI, GraphQL, and AsyncAPI specs into documentation scaffolds.

Updated Jan 23, 2026
One-click install
npx skills add https://github.com/brainfish-ai/devdoc --skill import-api-spec
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: import-api-spec
Source: https://github.com/brainfish-ai/devdoc/tree/main/public-apis/meta/.claude/skills/import-api-spec
Command: npx skills add https://github.com/brainfish-ai/devdoc --skill import-api-spec

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

OpenAPI, GraphQL, and AsyncAPI specifications are often scattered, inconsistent, and hard to publish. This Skill imports, validates, and organizes API specs into a consistent documentation-ready structure.

Core Features & Use Cases

  • Import and classify API specs by type (OpenAPI, GraphQL, AsyncAPI) based on file patterns.
  • Validate syntax, resolve $ref references, and extract servers, security, and endpoints.
  • Generate a documentation scaffold under api-reference including introduction, authentication, errors, and rate-limiting sections.
  • Use Case: A team receives multiple specs from vendors; this Skill consolidates them into a single, coherent API reference ready for publishing.

Quick Start

Place your spec files (openapi.yaml, swagger.yaml, schema.graphql, or asyncapi.yaml) in a folder and run the skill to produce the api-reference scaffold.

Frequently Asked Questions about import-api-spec

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

FAQPage Schema
How do I generate API documentation from OpenAPI and GraphQL specs?

Generate API documentation from OpenAPI and GraphQL specs by placing your YAML or JSON files in a folder and running the import process to validate syntax, resolve $ref references, and output a standardized api-reference directory.

What is the best way to consolidate multiple vendor API specs into a single reference?

Consolidating multiple vendor API specs involves importing and classifying files by type, extracting servers and security mappings, and generating a coherent documentation scaffold with introduction, authentication, and error sections.

Can I import AsyncAPI specifications alongside OpenAPI files for documentation?

Yes, you can import AsyncAPI specifications alongside OpenAPI files. The process detects the spec type by file patterns and applies syntax validation, server extraction, and authentication mappings across common spec formats.

How does $ref resolution work when ingesting OpenAPI YAML files?

$ref resolution works during spec ingestion by parsing the JSON or YAML files, validating the syntax, resolving internal references, and extracting endpoints and security schemes to produce ready-to-publish documentation.

What file formats are supported for importing API specifications?

Supported file formats for importing API specifications include JSON and YAML, accommodating common spec formats such as openapi.yaml, swagger.yaml, schema.graphql, and asyncapi.yaml.

Does the API spec import process handle authentication and security mappings?

Yes, the API spec import process handles authentication and security mappings by extracting security schemes from the specifications and generating dedicated authentication sections in the standardized documentation scaffold.