SwaggerHub 连接器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_15292d5a/yjkj-oo-swaggerhub。
技能介绍
需要解决的具体问题
在 API 治理与文档协作场景中,团队常需快速获取 SwaggerHub 中的 API 定义、版本列表、项目结构及注册表元数据。手动操作不仅耗时,还易因参数配置错误导致数据不一致。当需要批量拉取多个 API 的模板版本或跨所有者搜索注册表项时,传统界面操作难以满足自动化与可复现的需求。
技能如何工作
核心能力与关键步骤
- 14 个专用动作:覆盖 SwaggerHub 资源的读取与搜索操作,包括
get_api_definition、list_api_versions、search_registry_specs等。所有动作通过oo CLI调用连接器实现,无需在本地管理 API 密钥。 - 契约驱动执行:执行前建议先通过
oo connector schema获取当前动作的输入/输出契约,确保构造的 JSON payload 符合规范。响应统一包含data与meta.executionId,便于追溯执行记录。 - 安全分级执行:读取类动作(
get/list/search)可直接运行;涉及状态变更的操作(如未来扩展的创建、更新类动作)需在运行前与用户确认具体 payload 及影响范围。
适用边界与注意点
- 凭据托管:SwaggerHub 连接凭据由 OOMOL 服务端注入,本地无需处理 API Key 等敏感信息。首次使用需确保
oo CLI已安装、登录并完成 SwaggerHub 连接(认证类型:API Key),但无需手动执行登录或连接流程。 - 错误处理:若遇
scope_missing、credential_expired等错误,说明连接状态异常,需重新建立 SwaggerHub 连接;遇到HTTP 402时需检查 OOMOL 账户余额。 - 只读优先:当前版本聚焦于 SwaggerHub 资源的读取与检索场景,未提供修改或删除类操作,适合文档同步、版本审计、注册表盘点等非破坏性场景。
使用场景
- 在SwaggerHub中获取API的JSON或YAML定义,用于文档同步或版本审计
- 列出特定SwaggerHub API的所有可用版本,用于版本回溯或兼容性检查
- 在SwaggerHub注册表中搜索API、域或模板规范,用于资源盘点或元数据检索
- 通过所有者和项目标识符获取单个SwaggerHub项目的详细信息,用于项目结构分析
适合人员
- API文档工程师,需要自动化拉取SwaggerHub中的API定义和版本信息,确保文档与代码同步
- API治理团队成员,负责监控和管理SwaggerHub中的API资源,需要快速搜索和列出API、域或模板
- DevOps工程师,需要集成SwaggerHub资源到CI/CD流程,通过oo CLI获取项目结构或版本数据