Получение списка API платформы AceDataCloud - Ace Data Cloud

Постранично возвращает конечные точки API, видимые на текущем сайте. Подходит для поиска API по бизнес-пути, сервису или этапу публикации; если требуется только полное определение одного 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	Нет	Количество записей на странице, максимум 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 и другие.

Сериализатор списка в настоящее время содержит definition; при получении полного каталога следует использовать пагинацию и устанавливать тайм-аут. Поля могут добавляться с обратной совместимостью, клиент должен читать только необходимые поля.

Следующие шаги