SuperAPI AI 工具集

alicloud-platform-openapi-product-api-discovery

编程与开发

查看项目

更新于 10-15 17:34

技能介绍

用途:该技能用于发现与核对阿里云产品目录,并抓取 OpenAPI 的产品、版本和 API 元数据,最终生成可用于技能规划的产品与接口汇总。

主要能力:从三类来源获取产品列表,包括工单系统(ListProducts)、支持与服务(ListProductByGroup)和 BSS OpenAPI(QueryProductList);合并产品列表;抓取 OpenAPI 元数据产品清单;按产品与版本抓取 OpenAPI API 文档;将产品与 API 数量关联;按类别或分组汇总产品;可选地对比现有技能与产品。

使用方式:在技能目录下运行自带脚本,需为各脚本提供所需环境变量(参见参考资料)。示例命令:python scripts/products_from_ticket_system.py、python scripts/products_from_support_service.py、python scripts/products_from_bssopenapi.py、python scripts/merge_product_sources.py、python scripts/products_from_openapi_meta.py、python scripts/apis_from_openapi_meta.py、python scripts/join_products_with_api_meta.py、python scripts/summarize_openapi_meta_products.py、python scripts/analyze_products_vs_skills.py。抓取 API 文档默认数据量可能很大,可用筛选做试运行:OPENAPI_META_MAX_PRODUCTS=10、OPENAPI_META_PRODUCTS=Ecs,Ons、OPENAPI_META_VERSIONS=2014-05-26。

输出与验证:所有生成文件须放在 output/ 下。可用 py_compile 编译脚本进行校验,通过标准为命令退出码 0 且生成对应 validate.txt。证据文件应保存在 output/alicloud-platform-openapi-product-api-discovery/ 下,并记录区域、资源 ID、时间范围等关键参数。

前提与限制:执行前需配置最小权限的阿里云凭证,优先使用环境变量 ALICLOUD_ACCESS_KEY_ID、ALICLOUD_ACCESS_KEY_SECRET,可选 ALICLOUD_REGION_ID。区域不明确时,执行变更类操作前应先询问用户。API 元数据抓取可能产生大量请求,需用筛选条件控制范围。官方价格、收费、具体脚本参数细节及完整端点清单暂未提供。