asyncapi-docs

Solid

AsyncAPI specification handling for event-driven API documentation. Parse, validate, and generate documentation for message-based APIs including Kafka, MQTT, WebSocket, and AMQP systems.

AI & Automation 814 stars 53 forks Updated today MIT

Install

View on GitHub

Quality Score: 98/100

Stars 20%
97
Recency 20%
100
Frontmatter 20%
70
Documentation 15%
100
Issue Health 10%
50
License 10%
100
Description 5%
100

Skill Content

# AsyncAPI Documentation Skill Generate and validate documentation for event-driven APIs using the AsyncAPI specification with support for multiple messaging protocols. ## Capabilities - Parse and validate AsyncAPI 2.x and 3.x specifications - Generate documentation from AsyncAPI specs - Document event/message schemas - Channel and operation documentation - Protocol-specific binding documentation (Kafka, MQTT, WebSocket, AMQP) - Code generator integration - Spectral linting for AsyncAPI - Schema validation and type generation ## Usage Invoke this skill when you need to: - Document event-driven microservices - Create message broker API documentation - Generate client code from async specifications - Validate AsyncAPI specifications - Create interactive documentation sites ## Inputs | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | specPath | string | Yes | Path to AsyncAPI specification | | outputDir | string | No | Documentation output directory | | generator | string | No | html, markdown, react (default: html) | | validate | boolean | No | Run spec validation (default: true) | | lint | boolean | No | Run Spectral linting (default: true) | | generateCode | boolean | No | Generate client/server stubs | | codeLanguage | string | No | Code generation target language | ### Input Example ```json { "specPath": "./asyncapi.yaml", "outputDir": "docs/async", "generator": "html", "validate": true, "lint": true, "generate...

Details

Author
a5c-ai
Repository
a5c-ai/babysitter
Created
4 months ago
Last Updated
today
Language
JavaScript
License
MIT

Integrates with

Related Skills