APIs suchen und filtern

Diese Seite gilt für Apigee und Apigee Hybrid.

In diesem Thema wird beschrieben, wie Sie die intelligente Suche auf Basis von Vertex AI und filterbasierte Suchoptionen verwenden, um im API-Hub nach bestimmten Ressourcen zu suchen.

Mit der intelligenten Suche können Sie in Ihrem API-Hub registrierte API-Ressourcen ganz einfach finden und aufrufen. Mit der intelligenten Suche können Sie alle verfügbaren API-Ressourcen in Ihrer Instanz mit einer Freitextsuchabfrage durchsuchen. Sie können in allen Entitätstypen (APIs, API-Vorgänge, Spezifikationen usw.) suchen, oder geben Sie den Entitätstyp an, den Sie abfragen möchten.

Mit der Vertex AI-Suchmaschine geht die intelligente Suche über den Begriff „Abgleich“ hinaus. Die intelligente Suche gibt Ergebnisse mit Begriffen zurück, die an einer beliebigen Stelle in den detaillierten API-Ressourceneinträgen enthalten sind, die semantisch den eingegebenen Freitextsuchanfragen ähneln.

Bei der Freitextsuche wird eine paginierte Liste mit Suchergebnissen zurückgegeben, die die folgenden Details enthält:

  • Ressourcenname: Der Name der API, des API-Vorgangs oder der Spezifikationsdatei.
  • Ressourcenbeschreibung: Eine kurze Beschreibung der Ressource.
  • Ressourceninhaber: Der Name und die E-Mail-Adresse des Ressourceninhabers.
  • Link zu Ressourcendetails: Ein Link zur detaillierten Informationsseite für die Ressource.

So suchen Sie nach APIs, die einen bestimmten Begriff enthalten:

  1. Rufen Sie in der Google Cloud Console die Seite API-Hub Discover auf.

    Zum Discover API-Hub

  2. Geben Sie eine Suchanfrage in das Suchfeld ein.

    Sie können z. B. „APIs für die Bestellverwaltung“ oder „Spezifikationsdatei für die Einstellungen des Mobilfunkanbieters“ eingeben.

    Sie können Ihre Suche verfeinern, indem Sie Systemattribute im Suchanfrage-Prompt verwenden. Wenn Sie bei der Registrierung Ihrer APIs im API-Hub Nutzerattribute erstellt haben, können Sie diese Attribute auch in Ihre Suchanfrage-Prompts aufnehmen.

  3. In der Liste Suchergebnisse wird eine Liste von API-Ressourcen angezeigt, die semantische Begriffe enthalten, die der von Ihnen eingegebenen Suchanfrage ähneln.
  4. Klicken Sie auf den API-Ressourcennamen, um die Detailseite für die Ressource aufzurufen.
  5. Klicken Sie zum Löschen der aktuellen Abfrage auf Ergebnisse löschen.

Sie können Ihre API-Hub-Ressourcen auch mit der API Hub API durchsuchen. Mit der Methode searchResources können Sie Ihre API-Hub-Ressourcen mithilfe von Freitextabfragen und Filtern abfragen.

Mit dem folgenden API-Aufruf können Sie in Ihren API-Hub-Ressourcen suchen: 

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"
   }'

Wobei:

  • PROJECT_ID ist die ID des Hostprojekts für Ihre API-Hub-Instanz.
  • LOCATION ist der Standort, an dem Ihre API-Hub-Instanz gehostet wird.
  • QUERY ist die Freitextabfrage, die in der Suche verwendet werden soll. Die Abfrage kann Schlüsselwörter enthalten, die sich auf beliebige Details der API-Hub-Ressource beziehen, einschließlich Anzeigenamen, Beschreibungen oder anderer Metadaten.
  • RESOURCE_TYPE ist der optionale Filter, der für Ihre Suche angegeben wurde. Sie können einen der folgenden API-Hub-Ressourcentypen als Filter angeben:
    • Api
    • ApiOperation
    • Deployment
    • Definition
    • Spec
    • Version

Beispiel:

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"
    }'

Dieser Aufruf gibt eine paginierte Liste von API-Hub-Ressourcen zurück, darunter:

  • Der Anzeigename der Ressource.
  • Eine Beschreibung der Ressource.
  • Ein Link zur Dokumentation über die Ressourcen.
  • Der Inhaber der Ressource.

Wenn für die Ressource zusätzliche System- oder Nutzerattribute konfiguriert sind, werden auch die mit den Attributen verknüpften Metadaten zurückgegeben.

Weitere Informationen zur Freitextsuche mit der API Hub API finden Sie in der API-Referenzdokumentation für Method:project.locations.searchResources.

Filterbasierte Suchoptionen

Sie können die Liste der auf der Seite APIs angezeigten APIs verfeinern, indem Sie Systemattribute als Suchparameter verwenden. Passen Sie die Liste der API-Ressourcen mit einer der folgenden Optionen an:

Filter

Mit der filterbasierten Listensuche können Sie Ihre API-Liste auf der Grundlage einer Reihe vordefinierter Parameter und Systemattribute optimieren, die der Ressource zugeordnet sind. Mit der Option Match ALL oder Match ANY können Sie die gefilterte Ansicht anpassen.

So geben Sie Filteroptionen an:

  1. Rufen Sie in der Google Cloud Console die Seite API-Hub APIs auf.

    Zu "API-Hub-APIs"

  2. Klicken Sie in das Feld Tabelle filtern, um die Tabelle zu filtern. Der Filterbereich wird geöffnet.
  3. Geben Sie Filteroptionen an oder wählen Sie sie aus. Wenn Sie den Bereich "Filter" eingeben, wird ein Menü mit Filteroptionen angezeigt, das eine Liste von Systemattributen enthält, die für den aktuellen Kontext relevant sind. Das sind beispielsweise Systemattribute, die angezeigt werden, wenn Sie die APIs auf der Seite APIs filtern:
    • API-Name: Der Anzeigename der API
    • Geschäftseinheit: Die für eine API zuständige Geschäftseinheit
    • Team: Das für eine API zuständige Produktionsteam
    • Dokumentation: Ein kurzer Link zur API-Dokumentation.

      • Systemattribute werden in der Filterliste in den Tabellen APIs, Versionen und Spezifikationen angezeigt.

  4. Nachdem Sie eine Filteroption ausgewählt haben, wählen Sie einen Filterwert aus der Liste Werte aus. Alternativ können Sie einen Wert für das ausgewählte Filterattribut eingeben.
  5. Wenn Sie einen weiteren Filter hinzufügen möchten, klicken Sie in das Feld Filtertabelle, um aus den verfügbaren Operatoren auszuwählen, und wählen Sie dann ein anderes Filterattribut und einen anderen Filterwert aus.

  6. Die ausgewählten Filterattribute zeigen die bedingte Logik an, die von der Filterabfrage verwendet wird. Sie können OR als Operator auswählen. Wenn kein Operator ausgewählt ist, ist der Standardwert AND.

  7. Wenn Sie einen einzelnen Filter löschen möchten, klicken Sie auf das X des Filters. Klicken Sie im Bereich Filter auf Alle löschen, um alle Filter zu löschen.

Sortieren

So ordnen Sie die angezeigte API-Liste neu an:

  1. Rufen Sie in der Google Cloud Console die Seite API-Hub APIs auf.

    Zu "API-Hub-APIs"

    Die Seite mit der Liste der APIs wird standardmäßig angezeigt.

  2. Suchen Sie auf der Seite APIs-Liste die Spaltenüberschrift API-Name.
  3. Der Pfeil zeigt die aktuelle Sortierpriorität an. Ein Abwärtspfeil gibt die absteigende alphabetische Reihenfolge an. Ein Aufwärtspfeil gibt die aufsteigende alphabetische Reihenfolge an.
  4. Klicken Sie auf API-Name, um die API-Liste nach Namen zu sortieren.

Seitenumbruch

Wenn mehrere API-Ressourcen vorhanden sind, werden diese möglicherweise auf mehreren Seiten angezeigt.

So passen Sie die Listenanzeige an und wechseln zwischen Seiten:

  1. Rufen Sie in der Google Cloud Console die Seite API-Hub APIs auf.

    Zu "API-Hub-APIs"

    Die Seite mit der Liste der APIs wird standardmäßig angezeigt.

  2. Suchen Sie in der Liste APIs die Paginierungstools, wie unten gezeigt:

  3. Wählen Sie die Anzahl der pro Seite anzuzeigenden APIs aus.
  4. Klicken Sie auf > Weiter, um zur nächsten Seite zu gelangen.
  5. Klicken Sie auf < Zurück, um zur vorherigen Seite zu gelangen.

Nächste Schritte