AceDataCloud プラットフォーム API リストの取得 - Ace Data Cloud

現在のサイトで閲覧可能な API エンドポイントをページネーションで返します。ビジネスパス、サービス、またはリリースステージで API を検索するのに適しています。1 つの API の完全な定義のみが必要な場合は、直接 API 詳細を呼び出してください。

インターフェース概要

項目	内容
メソッド	`GET`
URL	`https://platform.acedata.cloud/api/v1/apis/`
認証	公開、アカウントトークン不要
ページネーション	`count` + `items`

クエリパラメータ

パラメータ	型	必須	説明
`path`	string	いいえ	`path` または `path2` の完全一致
`service`	string	いいえ	サービス alias または UUID
`stage`	string	いいえ	リリースステージでフィルタリング；複数の値を繰り返し渡すことが可能
`limit`	integer	いいえ	1 ページあたりの件数、最大 100
`offset`	integer	いいえ	ページネーションのオフセット

id、service_id、tag は現在リストのフィルタパラメータではありません。渡しても対応するフィルタ効果は発生しません。

curl --get 'https://platform.acedata.cloud/api/v1/apis/' \
  --data-urlencode 'service=midjourney' \
  --data-urlencode 'stage=Production' \
  --data-urlencode 'limit=20' \
  -H 'Accept: application/json'

import requests

response = requests.get(
    "https://platform.acedata.cloud/api/v1/apis/",
    params={"service": "midjourney", "limit": 20},
    timeout=30,
)
response.raise_for_status()
for api in response.json()["items"]:
    print(api["id"], api["method"], api["path"])

レスポンスの説明

オンラインレスポンスでは {count, items} を使用します。各リスト項目には現在、API モデルフィールドに加えて、以下が含まれます：

document_id：関連する開発者ドキュメント ID。空の場合があります；
service_id / service：メインサービス ID と要約。空の場合があります；
definition：OpenAPI 定義。大きくなる場合があります；
method、path、path2、stage、cost、tags、metadata など。

リスト serializer には現在 definition が含まれています。全量ディレクトリを取得する場合は、ページネーションを行い、タイムアウトを設定してください。フィールドは後方互換性を保ちながら追加される場合があるため、クライアントは必要なフィールドのみを読み取ってください。

次のステップ