SuperAPI AI 工具集

asyncapi-docs

数据与分析

查看项目

更新于 10-15 21:09

技能介绍

用途:处理事件驱动 API 的 AsyncAPI 规范,面向消息式 API(如 Kafka、MQTT、WebSocket、AMQP)进行解析、校验与文档生成,适用于事件驱动微服务、消息代理 API 文档、交互式文档站点以及异步规范校验等场景。

主要能力:解析并校验 AsyncAPI 2.x 与 3.x 规范;从规范生成文档;记录事件/消息 Schema;生成频道(channel)与操作(operation)文档;记录协议绑定(Kafka、MQTT、WebSocket、AMQP);集成代码生成器;使用 Spectral 对 AsyncAPI 进行 lint;Schema 校验与类型生成。

使用方式:调用该技能时可提供参数 specPath(必填,规范路径)、outputDir(输出目录)、generator(html、markdown、react,默认 html)、validate(默认 true)、lint(默认 true)、generateCode、codeLanguage。输出目录会生成 index.html、servers.html、channels、messages、schemas、bindings、search.json、asyncapi.json 等结构。相关 CLI 命令包括:asyncapi validate asyncapi.yaml;asyncapi generate fromTemplate asyncapi.yaml @asyncapi/html-template -o docs;asyncapi generate models asyncapi.yaml typescript -o src/types。依赖包含 @asyncapi/cli、@asyncapi/html-template、@asyncapi/markdown-template、@asyncapi/generator、@asyncapi/modelina、@stoplight/spectral-cli、@asyncapi/spectral-ruleset。

限制:具体收费、价格、平台支持及实际使用效果暂未提供,需自行核实。