alicloud-platform-openapi-product-api-discovery

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Alibaba Cloud Product + API Discovery

阿里云产品 + API 发现

Follow this workflow to collect products, resolve API metadata, and build summaries for skill planning.

按照此工作流收集产品、解析API元数据并构建Skill规划所需的汇总信息。

Workflow

工作流

Fetch product lists from the three sources

Ticket System (ListProducts)
Support & Service (ListProductByGroup)
BSS OpenAPI (QueryProductList)

Run the bundled scripts (from this skill folder):

bash

python scripts/products_from_ticket_system.py
python scripts/products_from_support_service.py
python scripts/products_from_bssopenapi.py

Provide required env vars in each script (see references).

Merge product lists

bash

python scripts/merge_product_sources.py

This writes

output/product-scan/merged_products.json

and

.md

Fetch OpenAPI metadata product list

bash

python scripts/products_from_openapi_meta.py

This writes

output/product-scan/openapi-meta/products.json

and

products_normalized.json

Fetch OpenAPI API docs per product/version

bash

python scripts/apis_from_openapi_meta.py

By default this can be large. Use filters for dry runs:

```
OPENAPI_META_MAX_PRODUCTS=10
```
```
OPENAPI_META_PRODUCTS=Ecs,Ons
```
```
OPENAPI_META_VERSIONS=2014-05-26
```

Join products with API counts

bash

python scripts/join_products_with_api_meta.py

Summarize products by category/group

bash

python scripts/summarize_openapi_meta_products.py

(Optional) Compare products vs existing skills

bash

python scripts/analyze_products_vs_skills.py

从三个来源获取产品列表

工单系统（ListProducts接口）
支持与服务平台（ListProductByGroup接口）
BSS OpenAPI（QueryProductList接口）

运行本Skill文件夹中附带的脚本：

bash

python scripts/products_from_ticket_system.py
python scripts/products_from_support_service.py
python scripts/products_from_bssopenapi.py

在每个脚本中提供所需的环境变量（请参考相关文档）。

合并产品列表

bash

python scripts/merge_product_sources.py

此脚本会生成

output/product-scan/merged_products.json

和

.md

文件。

获取OpenAPI元数据产品列表

bash

python scripts/products_from_openapi_meta.py

此脚本会生成

output/product-scan/openapi-meta/products.json

和

products_normalized.json

文件。

按产品/版本获取OpenAPI API文档

bash

python scripts/apis_from_openapi_meta.py

默认情况下生成的文件可能较大。试运行时可使用以下过滤器：

```
OPENAPI_META_MAX_PRODUCTS=10
```
```
OPENAPI_META_PRODUCTS=Ecs,Ons
```
```
OPENAPI_META_VERSIONS=2014-05-26
```

关联产品与API数量

bash

python scripts/join_products_with_api_meta.py

按类别/组汇总产品信息

bash

python scripts/summarize_openapi_meta_products.py

(可选) 对比产品与现有Skill

bash

python scripts/analyze_products_vs_skills.py

Output discipline

输出规范

All generated files must go under

output/

. Do not place temporary files elsewhere.

所有生成的文件必须存放在

output/

目录下，请勿在其他位置存放临时文件。

References

参考文档

Product source APIs: see
```
references/product-sources.md
```
OpenAPI meta endpoints: see
```
references/openapi-meta.md
```

产品来源API：详见
```
references/product-sources.md
```
OpenAPI元数据端点：详见
```
references/openapi-meta.md
```