Отримання списку 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; під час отримання повного каталогу слід використовувати пагінацію та встановити тайм-аут. Поля можуть додаватися зі зворотною сумісністю, клієнт має читати лише потрібні поля.

Наступний крок