Rechercher et filtrer des API

Cette page s'applique à Apigee et à Apigee hybrid.

Cet article explique comment utiliser la recherche intelligente fournie par Vertex AI et les options de recherche basées sur des filtres pour rechercher des ressources spécifiques dans le hub d'API.

La recherche intelligente vous permet de trouver et d'afficher facilement les ressources d'API enregistrées dans votre hub d'API. Elle vous permet également de rechercher toutes les ressources d'API disponibles dans votre instance à l'aide d'une requête de recherche en texte libre. Vous pouvez effectuer des recherches dans tous les types d'entités (API, opérations d'API, spécifications, etc.), ou spécifier le type d'entité que vous souhaitez interroger.

Avec son moteur de recherche Vertex AI, Smart Search va bien au-delà du terme "mise en correspondance". La recherche intelligente renvoie des résultats contenant des termes trouvés n'importe où dans les entrées de ressources d'API détaillées qui sont sémantiquement semblables aux requêtes de recherche de texte libre saisies.

La recherche en texte libre renvoie une liste paginée de résultats de recherche comprenant les informations suivantes :

  • Nom de la ressource : nom de l'API, de l'opération d'API ou du fichier de spécification.
  • Description de la ressource : brève description de la ressource.
  • Propriétaire de la ressource : nom et adresse e-mail du propriétaire de la ressource.
  • Lien vers les informations détaillées sur la ressource : lien vers la page d'informations détaillées de la ressource.

Pour rechercher des API contenant un terme spécifique, procédez comme suit :

  1. Dans la console Google Cloud, accédez à la page Découverte du hub d'API.

    Accéder à la page Découverte du hub d'API

  2. Saisissez une requête de recherche dans le champ de recherche.

    Par exemple, vous pouvez saisir "API de gestion des commandes" ou "Fichier de spécification pour les paramètres de l'opérateur sans fil".

    Vous pouvez affiner votre recherche en utilisant les attributs système dans votre invite de requête de recherche. Si vous avez créé des attributs utilisateur lors de l'enregistrement de vos API dans le hub d'API, vous pouvez également les intégrer dans vos invites de requête de recherche.

  3. La liste Résultats de recherche affiche une liste de ressources de l'API contenant des termes sémantiquement semblables à la requête de recherche que vous avez saisie.
  4. Cliquez sur le nom de ressource de l'API pour afficher la page d'informations de la ressource.
  5. Pour effacer la requête actuelle, cliquez sur Effacer les résultats.

Vous pouvez également effectuer une recherche dans les ressources de votre hub d'API à l'aide de l'API du hub d'API. La méthode searchResources vous permet d'interroger vos ressources de hub d''API à l'aide de requêtes et de filtres en texte libre.

Vous pouvez utiliser l'appel d'API suivant pour effectuer une recherche dans les ressources de votre hub d'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"
   }'

Où :

  • PROJECT_ID est l'ID du projet hôte pour votre instance de hub d'API.
  • LOCATION est l'emplacement où votre instance de hub d'API est hébergée.
  • QUERY est la requête de texte libre à utiliser dans la recherche. La requête peut contenir des mots clés en rapport avec n'importe quel détail de la ressource de hub d'API, y compris des noms à afficher, des descriptions ou d'autres métadonnées.
  • RESOURCE_TYPE correspond au filtre facultatif spécifié pour votre recherche. Vous pouvez spécifier l'un des types de ressources du hub d'API suivants en tant que filtre :
    • Api
    • ApiOperation
    • Deployment
    • Definition
    • Spec
    • Version

Par exemple :

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

Cet appel renvoie une liste paginée de ressources de hub d'API, y compris les suivantes :

  • Nom à afficher de la ressource.
  • Description de la ressource.
  • Lien vers la documentation sur les ressources.
  • Propriétaire de la ressource.

Si des attributs système ou des attributs utilisateur supplémentaires sont configurés pour la ressource, les métadonnées associées aux attributs sont également renvoyées.

Pour plus d'informations sur la recherche en texte libre avec l'API de hub d'API, consultez la documentation de référence de l'API pour Method:project.locations.searchResources.

Options de recherche basées sur des filtres

Vous pouvez affiner la liste des API affichées sur la page API en utilisant les attributs système en tant que paramètres de recherche. Si vous avez créé des attributs définis par l'utilisateur lors de l'enregistrement de vos API dans le hub d'API, vous pouvez également les intégrer dans vos requêtes de recherche. Personnalisez la liste des ressources d'API affichées à l'aide de l'une des options suivantes :

Filtre

La recherche de listes basée sur des filtres vous permet de simplifier votre liste d'API en fonction d'un certain nombre de paramètres et d'attributs système prédéfinis associés à la ressource. Vous pouvez utiliser les options Match ALL ou Match ANY pour personnaliser la vue filtrée.

Pour spécifier des options de filtrage, procédez comme suit :

  1. Dans la console Google Cloud, accédez à la page API du hub d'API.

    Accéder à la page API du hub d'API

  2. Cliquez dans le champ Filtrer le tableau pour filtrer le tableau. Le volet Filtre s'ouvre.
  3. Spécifiez ou sélectionnez les options de filtrage parmi les suivantes :
    • Nom de l'API : nom à afficher de l'API
    • Documentation : lien court vers la documentation de l'API.
  4. Après avoir sélectionné une option de filtre, sélectionnez une valeur de filtre dans la liste Valeurs. Vous pouvez également saisir une valeur pour l'attribut de filtre que vous sélectionnez.
  5. Pour ajouter un filtre supplémentaire, cliquez dans le champ Filtrer le tableau pour sélectionner l'un des Opérateurs disponibles, puis sélectionnez un autre attribut et une autre valeur de filtre.

  6. Les propriétés du filtre sélectionné affichent la logique conditionnelle utilisée par la requête de filtre. Vous pouvez sélectionner OR comme opérateur. Si aucun opérateur n'est sélectionné, la valeur par défaut est AND.

  7. Pour effacer un filtre individuel, cliquez sur le X dans le filtre. Pour effacer tous les filtres, cliquez sur Tout effacer dans le volet Filtre.

Tri

Pour réorganiser la liste des API affichées, procédez comme suit :

  1. Dans la console Google Cloud, accédez à la page API du hub d'API.

    Accéder à la page API du hub d'API

    La page de la liste des API s'affiche par défaut.

  2. Sur la page contenant la liste des API, localisez l'en-tête de colonne Nom de l'API.
  3. La flèche indique la priorité de tri actuelle. Une flèche vers le bas indique l'ordre décroissant. Une flèche vers le haut indique l'ordre croissant.
  4. Cliquez sur Nom de l'API pour trier la liste des API par nom.

Pagination

Lorsqu'il existe plusieurs ressources d'API, elles peuvent s'afficher sur plusieurs pages.

Pour personnaliser l'affichage de la liste et naviguer entre les pages, procédez comme suit :

  1. Dans la console Google Cloud, accédez à la page API du hub d'API.

    Accéder à la page API du hub d'API

    La page de la liste des API s'affiche par défaut.

  2. Dans la liste API, localisez les outils de pagination comme indiqué ci-dessous :

  3. Sélectionnez le nombre d'API à afficher par page.
  4. Cliquez sur > Suivant pour passer à la page suivante.
  5. Cliquez sur < Retour pour revenir à la page précédente.

Étape suivante