SuperAPI AI 工具集

openapi2cli

编程与开发

查看项目

更新于 10-16 03:08

技能介绍

用途:根据 OpenAPI 3.x 规范自动生成可执行的 Python CLI 脚本,把 API 端点映射为可发现的命令行子命令,适合希望以命令行而非原始 HTTP 方式与 API 交互的 AI 智能体或开发者。

主要能力:从 URL 或本地文件读取 OpenAPI/Swagger 规范生成 CLI;支持 API Key、Bearer Token、Basic 认证;每个命令提供 --help 帮助信息;返回结构化 JSON 输出便于解析;提供 dry-run 模式,只展示将要发送的请求而不实际发出。

使用方式:用 uvx 直接运行生成命令,例如 uvx openapi2cli generate https://api.example.com/openapi.json --output my-api,也支持本地文件如 uvx openapi2cli generate ./spec.yaml -o my-cli。可用 --base-url 覆盖基础地址。生成后通过 python my-api.py users list 之类的方式调用,认证可设环境变量(如 export MY_CLI_API_KEY="sk-...")或使用 --api-key 参数。命令与参数可通过 python my-cli.py --help 或 python my-cli.py users create --help 查看。

适用场景:需要频繁调用某 REST API、希望减少手写请求体、便于用管道串联命令或对智能体提供可探索命令接口时。

限制:资料仅说明支持 OpenAPI 3.x 规范,未提供对其它规范版本的支持情况;未说明支持的操作系统、Python 版本要求、生成文件的结构细节或是否覆盖全部 OpenAPI 特性,这些信息暂未提供。使用前建议先查看所生成 CLI 的 --help 说明。