Ottenere l'elenco delle API della piattaforma AceDataCloud - Ace Data Cloud

Restituisce in modo paginato gli endpoint API visibili sul sito corrente. Adatto per cercare API in base al percorso aziendale, al servizio o alla fase di rilascio; se è necessaria solo la definizione completa di una singola API, chiamare direttamente i dettagli API.

Panoramica dell’interfaccia

Voce	Contenuto
Metodo	`GET`
URL	`https://platform.acedata.cloud/api/v1/apis/`
Autenticazione	Pubblica, nessun token dell’account richiesto
Paginazione	`count` + `items`

Parametri di query

Parametro	Tipo	Obbligatorio	Descrizione
`path`	string	No	Corrispondenza esatta con `path` o `path2`
`service`	string	No	Alias o UUID del servizio
`stage`	string	No	Filtra per fase di rilascio; è possibile passare più valori ripetutamente
`limit`	integer	No	Numero di elementi per pagina, massimo 100
`offset`	integer	No	Offset di paginazione

id, service_id e tag al momento non sono parametri di filtro dell’elenco; passarli non produrrà il corrispondente effetto di filtro.

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"])

Descrizione della risposta

La risposta online utilizza {count, items}. Ogni elemento dell’elenco attualmente include i campi del modello API, nonché:

document_id: ID del documento per sviluppatori associato, potrebbe essere vuoto;
service_id / service: ID e riepilogo del servizio principale, potrebbero essere vuoti;
definition: definizione OpenAPI, potrebbe essere grande;
method, path, path2, stage, cost, tags, metadata, ecc.

Il serializer dell’elenco attualmente include definition; quando si recupera l’intero catalogo, è necessario utilizzare la paginazione e impostare un timeout. I campi potrebbero essere aggiunti in modo retrocompatibile; il client deve leggere solo i campi necessari.

Passaggi successivi