asyncapi-spec-generator

Name: asyncapi-spec-generator
Availability: InStock
Author: foo-x

Generate AsyncAPI 3.0.0 YAML specifications from project code and documentation.

2|1|Updated Feb 2, 2019

Search Tags:#code analysis #documentation #asyncapi #event-driven #protocol detection #api specification

Ready to run

npx skills add https://github.com/Foo-x/dotfiles --skill asyncapi-spec-generator

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: asyncapi-spec-generator
Source: https://github.com/Foo-x/dotfiles/tree/main/claude/skills/asyncapi-spec-generator
Command: npx skills add https://github.com/Foo-x/dotfiles --skill asyncapi-spec-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires PyYAML, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill automates the creation of AsyncAPI 3.0.0 specification documents from project code and documentation, saving significant manual effort in API documentation.

Core Features & Use Cases

Automatic Specification Generation: Analyzes project documentation (CLAUDE.md, AGENT.md) and code to generate AsyncAPI 3.0.0 compliant YAML specifications.
Protocol Detection: Intelligently detects communication protocols (Kafka, MQTT, AMQP, etc.) from project configurations and code.
Use Case: When starting a new microservice project that uses event-driven communication, use this Skill to quickly generate an initial AsyncAPI specification based on existing code and documentation, ensuring consistent API documentation from the start.

Quick Start

Use the asyncapi-spec-generator skill to analyze the current project and generate an asyncapi.yaml file.

Frequently Asked Questions about asyncapi-spec-generator

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

FAQPage Schema

How do I generate AsyncAPI 3.0.0 specifications from existing code?▼

You can generate AsyncAPI 3.0.0 specifications automatically by analyzing project documentation and code. The skill extracts channel, message, and operation definitions to produce a compliant YAML file without manual writing.

What protocols are automatically detected when generating AsyncAPI documents?▼

AsyncAPI document generation detects communication protocols including Kafka, RabbitMQ, MQTT, NATS, Redis Streams, AWS SNS/SQS, and WebSocket directly from your project configurations and source code.

Can I use this tool to document an event-driven microservice project?▼

Yes, you can document event-driven microservice projects by using this skill to analyze existing code and documentation, ensuring consistent API specifications from the start of your project lifecycle.

Does generating AsyncAPI specs require manually defining channels and messages?▼

No, generating AsyncAPI specs does not require manual definitions. The skill intelligently extracts channel, message, and operation definitions from your codebase and project files like CLAUDE.md or AGENT.md.

How does protocol detection work for AsyncAPI YAML formatting?▼

Protocol detection works by analyzing project configurations and code to identify communication patterns. It supports progressive disclosure of protocol-specific references and applies best practices for schema extraction and YAML formatting.

What is the best way to maintain AsyncAPI specs for event-driven architecture?▼

The best way to maintain AsyncAPI specs is to automate generation by analyzing project documentation and code. This ensures your YAML specifications accurately reflect current channels, messages, and operations without manual effort.