SuperAPI AI 工具集

api-publish

部署与运维

查看项目

更新于 10-16 02:14

技能介绍

用途

api-publish 用于端到端地搭建和管理 WSO2 API Platform Gateway,帮助开发者使用 ap CLI 将已有后端服务暴露为网关管理的 API。典型场景是用户已有一个运行中的服务(例如位于 localhost:8081),希望将其作为网关管理的 API 对外提供访问。该技能假设用户理解 HTTP,但可能不熟悉 API 网关。

主要能力

  • 检查并安装 ap CLI:检测平台并下载匹配的 ap CLI 发行版,将二进制安装到相应位置(Linux/macOS:~/.local/bin/ap;Windows:%LOCALAPPDATA%\Programs\ap\ap.exe),并确保安装目录加入 PATH。
  • 查找或搭建网关:通过 ap gateway list 查看已注册网关;可选择连接已有网关,或搭建全新的本地网关。搭建本地网关时会确认 Docker 是否安装,并使用脚本将网关发行版解压到 ~/wso2-api-gateway/v<版本>/ 并启动 Docker Compose。
  • 连接 ap CLI:根据网关类型使用 ap gateway add 命令注册网关;本地网关由脚本使用网关附带的默认配置自动完成,涉及真实用户凭据的网关则由用户在自己的终端中交互式输入凭据。
  • 校验网关健康:通过 ap gateway health 检查网关状态。
  • 发布 API:根据 OpenAPI 规范或用户提供的后端 URL 与端点列表(方法 + 路径),生成 RestApi YAML 资源文件并发布到网关,随后测试线上端点。
  • API 就绪性评估:在发布前可选择对 OpenAPI 规范进行评估,检查 AI 智能体就绪度、安全性和设计质量。

使用方式

该技能以分阶段流程推进。阶段一为搭建:先向用户展示面向结果的简短计划,然后依次检查并安装 ap CLI、查找或搭建网关、连接 CLI、校验网关健康。阶段二为发布 API:先展示简短计划,收集服务详情(询问是否已有 OpenAPI 规范),确认 API 是公开还是需要认证,处理 Docker 网络问题后生成 YAML 并发布,最后测试线上端点。

执行过程中使用 ✓ 表示成功、✗ 表示失败;遇到失败时先诊断可能原因并提出修复方案,再尝试其他途径。技能提供参考文件(ap CLI 命令参考、带注解的 RestApi YAML 示例、Docker 网络解决方案),按需读取而非预先全部加载。还附带脚本:scripts/install-ap-cli.js(安装 ap CLI)、scripts/setup-gateway.js(解压并启动网关 Compose 栈)、scripts/init-local-cli-config.js(写入本地 CLI 配置),均通过 node 以绝对路径调用。

相关文档位于 wso2/api-platform 仓库的两个发行线分支:网关与 REST API 文档在 gw-docs-1.1.x,CLI 文档在 ap-docs-0.8.x,不回落至 main 分支。

适用场景

  • 将运行在本机或远程的后端服务发布为网关管理的 API。
  • 搭建本地 WSO2 API Platform Gateway 并验证其健康状态。
  • 连接已有的 API 平台网关并通过 CLI 管理。
  • 在 API 发布前进行就绪性、安全与设计质量评估。
  • 使用 ap CLI 对网关和 API 进行日常管理操作。

限制

  • 本地网关搭建依赖 Docker 与 Docker Compose;若未安装 Compose,脚本会以非零状态退出并提示安装 Docker Desktop 或其他替代方案。
  • 当后端运行在用户本机时,上游 URL 不能使用 localhost,因为网关运行在 Docker 内,localhost 会解析为容器自身;需检测主机 LAN IP 替代。
  • 对于涉及真实用户凭据的已有网关,智能体不代为运行 ap gateway add,也不在任何命令中包含凭据;用户需在自己的终端中运行并交互式输入凭据。若用户粘贴密码或令牌,不应回显、不应包含在命令中、也不应存储。
  • 具体收费、价格、平台支持矩阵与效果指标暂未提供。