SuperAPI AI 工具集

arch-api

编程与开发

查看项目

更新于 10-16 04:59

技能介绍

用途:arch-api 是 OpenClaw 的一项技能,用于设计、文档化和实现 API 架构,重点覆盖 REST 原则、版本控制策略、HATEOAS、认证模式、OpenAPI 规范以及 API 网关设计,目标是让 API 可扩展、安全且符合标准。

适用场景:设计新的 RESTful API、将遗留 API 迁移到现代标准、为向后兼容实现版本控制、引入超媒体驱动的 HATEOAS 响应;也适用于微服务环境、为 Swagger UI 生成 OpenAPI 文档,或评估 JWT 等受保护端点的认证模式。

主要能力:REST 设计可生成 URI 结构(如 /resources/{id})并映射 HTTP 方法与响应码;版本控制支持 URI 方式(如 /v1/resources)或请求头方式(如 Accept: application/vnd.myapi.v1+json);HATEOAS 可在 JSON 响应中加入 self 与相关资源链接;认证模式支持 JWT 或 OAuth2 流程,含令牌校验与作用域;OpenAPI 文档可从代码或设计自动生成 OpenAPI 3.0 YAML/JSON 规范;网关模式可设计路由、负载均衡等 API 网关方案。

使用方式:通过 OpenClaw CLI 调用,命令结构为 openclaw arch-api <subcommand> [flags]。运行前需设置认证密钥:export OPENCLAW_API_KEY=your_api_key。例如设计 REST API:openclaw arch-api design --type rest --version v1 --hateoas;生成 OpenAPI 文档:openclaw arch-api docs --input api-spec.json --output openapi.yaml。常用标志包括 --hateoas、--auth jwt、--validate、--gateway kong 等。复杂输入可用 JSON 或 YAML 配置文件,输出可管道给 jq 等工具处理。

限制与错误处理:命令返回非零退出码时需解析 stderr 中的错误信息;API 调用遇到 401 可用刷新后的密钥重试,400 通常表示输入格式错误(如缺少 --version),403 表示密钥无效。资料未提供具体收费、价格或平台支持范围等信息。