用途:该技能面向技术文档场景,负责生成并校验 API 文档,覆盖 OpenAPI/Swagger 规范、REST 端点说明、认证流程与错误码等内容。
主要能力:输入支持 api_type(rest、graphql、websocket、grpc),可来自已有 OpenAPI 规范、源码文件或手工端点列表;输出格式可选 openapi、asyncapi、markdown、html,OpenAPI 版本支持 3.0.0 与 3.1.0。可配置是否包含示例、错误码、认证与限流说明,认证类型支持 bearer、api_key、oauth2、basic、none。输出包含规范/文档内容、校验结果(错误与警告)以及完整性、示例覆盖、错误覆盖等质量评分,并统计已文档化端点数、生成 schema 数与示例数。
使用方式:按输入 schema 提供 api_type 与 api_info(title、version 必填,version 需符合 semver),可选 source、output_format、openapi_version 及各类 include_* 开关。技能内置参数校验规则、带退避的重试逻辑(仅对 RATE_LIMITED、TIMEOUT、TEMPORARY_FAILURE、SERVICE_UNAVAILABLE 等可重试错误重试),以及执行前、执行后与错误钩子用于日志和指标采集。
适用场景:为 REST/GraphQL/WebSocket/gRPC 服务编写规范文档、从代码或端点清单生成 OpenAPI 描述、补充认证与错误响应说明。
限制:资料未提供具体安装命令、运行环境、收费方式与平台支持信息;质量评分低于 70 时会记录警告,但资料未说明其具体计算细节。