OpenAPI转CLI工具

技能简介

openapi2cli 是一款从 OpenAPI 3.x 规范自动生成命令行工具的工具。它把 API 文档转换成可直接执行的 Python CLI，省去手写 curl 命令的繁琐。

业务背景

开发团队对接第三方或内部 API 时，无需逐条阅读文档、手写 curl 命令或封装 SDK。该工具将 OpenAPI 规范一键转为可执行的 Python CLI，降低接口调试门槛，让非技术同事也能快速调用 API，缩短联调周期。

落地案例：某电商平台需频繁调用物流商的追踪接口。运维人员将物流商提供的 OpenAPI YAML 文件输入工具，自动生成带 –help 的 CLI 脚本。客服团队直接运行 python cli.py shipment track –order_id=12345 查询物流状态，无需等待开发排期封装接口，问题响应从小时级降至分钟级。

能做什么

• 读取 OpenAPI JSON/YAML 规范，生成完整 CLI 脚本
• 自动识别路径参数、查询参数、请求体结构
• 支持多种认证方式：API Key、Bearer Token、Basic Auth
• 提供 –help 查看每个命令的参数说明
• 输出结构化 JSON，方便管道处理
• 干跑模式预览请求，不实际发送

使用说明

安装依赖

# 安装 uv（提供 uvx 命令）
pip install uv

生成 CLI

# 从 URL 生成
uvx openapi2cli generate https://api.example.com/openapi.json -o my-cli

# 从本地文件生成
uvx openapi2cli generate ./spec.yaml -o my-cli

# 指定基础 URL
uvx openapi2cli generate ./spec.json -o my-cli --base-url https://api.prod.com

使用生成的 CLI

# 设置认证（环境变量方式）
export MY_CLI_API_KEY="sk-..."

# 或通过命令行参数
python my-cli.py --api-key "sk-..." users list

# 查看可用命令
python my-cli.py --help

# 查看具体命令参数
python my-cli.py users create --help

输入与输出

见下方输入与输出表格。

风险提示

• 生成的 CLI 依赖 Python 运行环境，需确保目标机器已安装 Python 3
• API Key 等敏感信息通过环境变量或命令行传递，注意避免泄露到 shell 历史记录
• 干跑模式仅显示请求构造结果，不验证网络连通性
• 复杂 OpenAPI 特性（如回调、链接）可能未完全支持

来源信息

原始链接：https://github.com/openclaw/skills/tree/main/skills/awlevin/openapi2cli/SKILL.md
来源类型：GitHub 仓库