aliyun-openapi-discovery について
aliyun-openapi-discoveryは、Alibaba Cloudの製品一覧とOpenAPIメタデータを収集するワークフロースキルです。製品情報を統合し、APIドキュメントを取得して、スキルの計画に使える要約を作成します。
主な機能
- 013つのソースから製品を収集
- 02製品一覧の統合
- 03OpenAPIメタデータとドキュメントの取得
- 04製品とAPI件数の照合
- 05カテゴリ別の製品集計
活用シーン
- 01スキル計画用の製品一覧の作成
- 02製品とバージョン別のAPIドキュメント検索
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ cinience/ alicloud-skills --skill aliyun-openapi-discoveryインストール後、Claude Code で/aliyun-openapi-discoveryを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
agents/openai.yamlreferences/openapi-meta.mdproduct-sources.mdscripts/analyze_products_vs_skills.pyapis_from_openapi_meta.pyjoin_products_with_api_meta.pymerge_product_sources.pyproducts_from_bssopenapi.pyproducts_from_openapi_meta.pyproducts_from_support_service.pyproducts_from_ticket_system.pysummarize_openapi_meta_products.py詳細
Alibaba Cloud の製品と API の調査
このワークフローに従って、製品を収集し、API メタデータを解決して、スキル計画用の概要を作成します。
ワークフロー
- 3 つのソースから製品リストを取得します
- チケットシステム(ListProducts)
- サポートとサービス(ListProductByGroup)
- BSS OpenAPI(QueryProductList)
このスキルフォルダーに含まれているスクリプトを実行します。
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
これにより、output/product-scan/merged_products.json と .md が書き込まれます。
- OpenAPI メタデータの製品リストを取得します
python scripts/products_from_openapi_meta.py
これにより、output/product-scan/openapi-meta/products.json と products_normalized.json が書き込まれます。
- 製品/バージョンごとに OpenAPI API ドキュメントを取得します
python scripts/apis_from_openapi_meta.py
デフォルトでは、取得量が多くなることがあります。ドライランではフィルターを使用してください。
OPENAPI_META_MAX_PRODUCTS=10OPENAPI_META_PRODUCTS=Ecs,OnsOPENAPI_META_VERSIONS=2014-05-26
- 製品と API 数を結合します
python scripts/join_products_with_api_meta.py
- カテゴリ/グループごとに製品を要約します
python scripts/summarize_openapi_meta_products.py
- (任意)製品と既存のスキルを比較します
python scripts/analyze_products_vs_skills.py
出力のルール
生成されるすべてのファイルは output/ 配下に配置してください。一時ファイルをほかの場所に配置しないでください。
検証
mkdir -p output/aliyun-openapi-discovery
for f in skills/platform/openapi/aliyun-openapi-discovery/scripts/*.py; do
python3 -m py_compile "$f"
done
echo "py_compile_ok" > output/aliyun-openapi-discovery/validate.txt
合格基準:コマンドが 0 で終了し、output/aliyun-openapi-discovery/validate.txt が生成されること。
出力と証拠
- 成果物、コマンド出力、API レスポンスの概要を
output/aliyun-openapi-discovery/に保存してください。 - 再現性を確保するため、主要なパラメーター(リージョン/リソース ID/期間)を証拠ファイルに含めてください。
前提条件
- 実行前に、最小権限の Alibaba Cloud 認証情報を設定してください。
- 環境変数を使用することを推奨します:
ALIBABACLOUD_ACCESS_KEY_ID、ALIBABACLOUD_ACCESS_KEY_SECRET、任意でALIBABACLOUD_REGION_ID。 - リージョンが不明な場合は、変更を伴う操作を実行する前にユーザーに確認してください。
参考資料
- 製品ソース API:
references/product-sources.mdを参照してください - OpenAPI メタエンドポイント:
references/openapi-meta.mdを参照してください
コメント
Markdown 対応