Cercare e filtrare le API

Questa pagina si applica a Apigee e Apigee ibridi.

Questo argomento descrive come utilizzare la ricerca intelligente basata su Vertex AI e le opzioni di ricerca basate su filtri per eseguire ricerche per risorse specifiche nell'hub API.

Puoi trovare e visualizzare facilmente le risorse API registrate nell'hub API utilizzando la ricerca intelligente. La ricerca intelligente ti consente per cercare tutte le risorse API disponibili nell'istanza utilizzando una query di ricerca in testo libero. Puoi cercare in tutti i tipi di entità (API, operazioni API, specifiche e così via), o specifica il tipo di entità su cui vuoi eseguire la query.

Con il suo motore di ricerca Vertex AI, la ricerca intelligente può andare oltre il termine "corrispondenza". La Ricerca intelligente restituisce risultati contenenti termini presenti in qualsiasi punto delle voci dettagliate delle risorse API semanticamente simili alle query di ricerca a testo libero inserite.

La ricerca a testo libero restituisce un elenco impaginato di risultati di ricerca che includono i seguenti dettagli:

  • Nome risorsa: il nome dell'API, l'operazione API o il file delle specifiche.
  • Descrizione della risorsa: una breve descrizione della risorsa.
  • Proprietario risorsa: il nome e l'indirizzo email del proprietario della risorsa.
  • Link dei dettagli della risorsa: un link alla pagina delle informazioni dettagliate per la risorsa.

Per cercare le API contenenti un termine specifico:

  1. Nella console Google Cloud, vai alla pagina Scopri dell'hub API.

    Vai a Discover hub API

  2. Digita una query di ricerca nella casella di ricerca.

    Ad esempio, puoi inserire "API di gestione degli ordini" o "File delle specifiche per le impostazioni dell'operatore wireless".

    Puoi perfezionare la ricerca utilizzando gli attributi di sistema all'interno del prompt della query di ricerca. Se hai creato attributi utente quando registri le tue API nell'hub API, puoi anche incorporare questi attributi nei prompt delle query di ricerca.

  3. L'elenco Risultati di ricerca mostra un elenco di risorse API che contengono termini semanticamente simili alla query di ricerca che hai inserito.
  4. Fai clic sul nome della risorsa API per visualizzare la pagina dei dettagli della risorsa.
  5. Per cancellare la query corrente, fai clic su Cancella risultati.

Puoi anche cercare le risorse dell'hub API utilizzando l'API dell'hub API. Il metodo searchResources consente di eseguire query sulle risorse dell'hub API utilizzando query di testo e filtri liberi.

Puoi utilizzare la seguente chiamata API per eseguire ricerche nelle risorse dell'hub API: 

curl -X POST https://apihub.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION:searchResources \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" \
  -d '{
    "query":"QUERY",
    "filter":"resource_type = RESOURCE_TYPE"
   }'

Dove:

  • PROJECT_ID è l'ID del progetto host per l'istanza dell'hub API.
  • LOCATION è la località in cui è ospitata l'istanza dell'hub API.
  • QUERY è la query di testo libera da utilizzare nella ricerca. La query può contenere parole chiave relative a qualsiasi dettaglio della risorsa dell'hub API, inclusi nomi visualizzati, descrizioni o altri metadati.
  • RESOURCE_TYPE è il filtro facoltativo specificato per la ricerca. Puoi specificare uno dei seguenti i seguenti tipi di risorse dell'hub API come filtro:
    • Api
    • ApiOperation
    • Deployment
    • Definition
    • Spec
    • Version

Ad esempio: 

curl -X POST https://apihub.googleapis.com/v1/projects/{project-id}/locations/{location}:searchResources \
  -H "Authorization: Bearer $(gcloud auth print-access-token)" -H "Content-Type: application/json" \
  -d '{
    "query":"dog status in the store",
    "filter":"resource_type = SPEC"
    }'

Questa chiamata restituisce un elenco impaginato di risorse dell'hub API, tra cui:

  • Il nome visualizzato della risorsa.
  • Una descrizione della risorsa.
  • Un link alla documentazione sulle risorse.
  • Il proprietario della risorsa.

Se per la risorsa sono configurati attributi di sistema o attributi utente aggiuntivi, i metadati associati a vengono restituiti anche gli attributi.

Per ulteriori informazioni sulla ricerca a testo libero con l'API dell'hub API, consulta la documentazione di riferimento API per Method:project.locations.searchResources.

Opzioni di ricerca basate su filtri

Puoi perfezionare l'elenco delle API visualizzate nella pagina API utilizzando gli attributi di sistema come parametri di ricerca. Se hai creato attributi utente durante la registrazione delle tue API nell'hub API, puoi incorporare questi attributi anche nelle tue query di ricerca. Personalizza l'elenco delle risorse API visualizzate utilizzando uno dei seguenti:

Filtro

Utilizzando la ricerca in elenco basata su filtri, puoi semplificare l'elenco delle API in base a una serie di parametri predefiniti e di sistema associati alla risorsa. Puoi utilizzare le opzioni Match ALL o Match ANY per personalizzare la visualizzazione filtrata.

Per specificare le opzioni di filtro:

  1. Nella console Google Cloud, vai alla pagina API dell'hub API.

    Vai alle API dell'hub API

  2. Fai clic nel campo Filtra tabella per filtrare la tabella. Si apre il riquadro Filtro.
  3. Specifica o seleziona le opzioni di filtro tra quelle riportate di seguito:
    • Nome API: il nome visualizzato dell'API
    • Documentazione: un breve link alla documentazione dell'API.
  4. Dopo aver selezionato un'opzione di filtro, seleziona un valore di filtro dall'elenco Valori. In alternativa, puoi inserire un valore per l'attributo di filtro selezionato.
  5. Per aggiungere un altro filtro, fai clic nel campo Filtra tabella per selezionare uno degli Operatori disponibili e selezionane un altro. l'attributo e il valore del filtro.

  6. Le proprietà di filtro selezionate mostrano lo stato usata dalla query di filtro. Puoi selezionare OR come operatore. In caso contrario viene selezionato, il valore predefinito è AND.

  7. Per cancellare un singolo filtro, fai clic sulla X del filtro. Per cancellare tutti i filtri, fai clic su Cancella tutto nel riquadro Filtro.

Ordina

Per riordinare l'elenco delle API visualizzate:

  1. Nella console Google Cloud, vai alla pagina API dell'hub API.

    Vai alle API dell'hub API

    Per impostazione predefinita viene visualizzata la pagina di elenco API.

  2. Nella pagina di elenco API, individua l'intestazione della colonna Nome API.
  3. La freccia indica la priorità di ordinamento corrente. Una freccia rivolta verso il basso indica l'ordine alfabetico decrescente. Una freccia rivolta verso l'alto indica l'ordine alfabetico crescente.
  4. Fai clic su Nome API per ordinare l'elenco delle API per nome.

Impaginazione

Quando sono presenti più risorse dell'API, queste potrebbero essere visualizzate su più pagine.

Per personalizzare la visualizzazione dell'elenco e navigare tra le pagine:

  1. Nella console Google Cloud, vai alla pagina API dell'hub API.

    Vai alle API dell'hub API

    Per impostazione predefinita viene visualizzata la pagina di elenco API.

  2. Dall'elenco API, individua gli strumenti di impaginazione come mostrato di seguito:

  3. Seleziona il numero di API da visualizzare per pagina.
  4. Fai clic su > Avanti per passare alla pagina successiva.
  5. Fai clic su < Indietro per passare alla pagina precedente.

Passaggi successivi