Busca y filtra APIs

Esta página se aplica a Apigee y Apigee Hybrid.

En este tema, se describe cómo usar la búsqueda inteligente con la tecnología de Vertex AI y las opciones de búsqueda basadas en filtros para buscar recursos específicos en el centro de APIs.

Con la búsqueda inteligente, puedes encontrar y ver fácilmente los recursos de API registrados en tu concentrador de APIs. La búsqueda inteligente te permite buscar todos los recursos de API disponibles en tu instancia mediante una consulta de búsqueda de texto libre. Puedes buscar en todos los tipos de entidades (APIs, operaciones de API, especificaciones, etc.) o especificar el tipo de entidad que deseas consultar.

Con su motor de búsqueda de Vertex AI, la Búsqueda inteligente puede ir más allá del término “coincidencia”. La búsqueda inteligente muestra resultados que contienen términos encontrados en cualquier parte de las entradas detalladas de recursos de API que son semánticamente similares a las consultas de búsqueda de texto libre ingresadas.

La búsqueda de texto libre muestra una lista paginada de resultados de la búsqueda que incluye los siguientes detalles:

  • Nombre del recurso: el nombre de la API, la operación de API o el archivo de especificación.
  • Descripción del recurso: Una descripción breve del recurso.
  • Propietario del recurso: El nombre y la dirección de correo electrónico del propietario del recurso.
  • Vínculo de detalles del recurso: Un vínculo a la página de información detallada del recurso.

Para buscar las API que contienen un término específico, sigue estos pasos:

  1. En la consola de Google Cloud, dirígete a la página Descubrir del concentrador de APIs.

    Ir a Descubrir del concentrador de APIs

  2. Escribe una búsqueda en el cuadro de búsqueda.

    Por ejemplo, puedes ingresar "APIs de administración de pedidos" o "Archivo de especificaciones para la configuración del proveedor inalámbrico".

    Puedes definir mejor tu búsqueda con los atributos del sistema en el mensaje de búsqueda. Si creaste atributos de usuario cuando registraste tus APIs en el centro de API, también puedes incorporar estos atributos en los mensajes de búsqueda.

  3. La lista Resultados de la búsqueda mostrará una lista de recursos de API que contienen términos semánticamente similares a la búsqueda que ingresaste.
  4. Haz clic en el nombre del recurso de API para ver la página de detalles del recurso.
  5. Para borrar la búsqueda actual, haz clic en Borrar resultados.

También puedes buscar recursos de tu centro de APIs mediante la API del centro de APIs. El método searchResources te permite consultar los recursos del centro de APIs mediante consultas y filtros de texto libre.

Puedes usar la siguiente llamada a la API para buscar en los recursos del centro de 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"
   }'

Aquí:

  • PROJECT_ID es el ID del proyecto host para tu instancia del centro de API.
  • LOCATION es la ubicación en la que se aloja la instancia del centro de APIs.
  • QUERY es la consulta de texto libre que se usará en la búsqueda. La consulta puede contener palabras clave relacionadas con cualquier detalle del recurso del centro de API, incluidos los nombres visibles, las descripciones y otros metadatos.
  • RESOURCE_TYPE es el filtro opcional que se especifica para tu búsqueda. Puedes especificar uno de los siguientes tipos de recursos del centro de APIs como filtro:
    • Api
    • ApiOperation
    • Deployment
    • Definition
    • Spec
    • Version

Por ejemplo:

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

Esta llamada muestra una lista paginada de recursos del centro de APIs, incluidos los siguientes:

  • El nombre visible del recurso.
  • Es una descripción del recurso.
  • Un vínculo a la documentación sobre los recursos.
  • El propietario del recurso.

Si se configuran atributos de sistema o atributos de usuario adicionales para el recurso, también se muestran los metadatos asociados con los atributos.

Para obtener más información sobre la búsqueda de texto libre con la API del centro de APIs, consulta la documentación de referencia de la API para Method:project.locations.searchResources.

Opciones de búsqueda basada en filtros

Puedes definir mejor la lista de APIs que se muestran en la página APIs mediante los atributos del sistema como parámetros de búsqueda. Si creaste atributos de usuario cuando registraste tus APIs en el centro de APIs, también puedes incorporar estos atributos en tus búsquedas. Personaliza la lista de recursos de API que se muestran mediante una de las siguientes opciones:

Filtro

Con la búsqueda de lista basada en filtros, puedes optimizar tu lista de APIs en función de varios parámetros predefinidos y atributos de sistema asociados con el recurso. Puedes usar las opciones Match ALL o Match ANY para personalizar la vista filtrada.

Para especificar opciones de filtro, haz lo siguiente:

  1. En la consola de Google Cloud, dirígete a la página APIs del concentrador de APIs.

    Ir a APIs del concentrador de APIs

  2. Haz clic en el campo Filtrar tabla para filtrar la tabla. Se abrirá el panel Filtro.
  3. Especifica o selecciona las opciones de filtro de las siguientes opciones:
    • Nombre de la API: El nombre visible de la API
    • Documentación: un vínculo corto a la documentación de la API.
  4. Después de seleccionar una opción de filtro, selecciona un valor de filtro de la lista Valores. También puedes ingresar un valor para el atributo de filtro que selecciones.
  5. Para agregar un filtro adicional, haz clic en el campo Filtrar tabla para seleccionar entre los Operadores disponibles y, luego, selecciona otro atributo y valor de filtro.

  6. Las propiedades de filtro seleccionadas muestran la lógica condicional que usa la consulta de filtro. Puedes seleccionar OR como operador. Si no hay un operador seleccionado, el valor predeterminado es AND.

  7. Para borrar un filtro individual, haz clic en la X del filtro. Para borrar todos los filtros, haz clic en Clear all en el panel Filtro.

Ordenar

Para reordenar la lista de las API que se muestran, haz lo siguiente:

  1. En la consola de Google Cloud, dirígete a la página APIs del concentrador de APIs.

    Ir a APIs del concentrador de APIs

    La página de lista de API se muestra de forma predeterminada.

  2. En la página de la lista de API, busca el encabezado de la columna Nombre de la API.
  3. La flecha indica la prioridad de orden actual. Una flecha hacia abajo indica el orden alfabético descendente. Una flecha hacia arriba indica el orden alfabético ascendente.
  4. Haz clic en el nombre de la API para ordenar la lista de API por nombre.

Paginación

Cuando hay varios recursos de API, pueden mostrarse en varias páginas.

Para personalizar la visualización de la lista y navegar entre páginas, sigue estos pasos:

  1. En la consola de Google Cloud, dirígete a la página APIs del concentrador de APIs.

    Ir a APIs del concentrador de APIs

    La página de lista de API se muestra de forma predeterminada.

  2. En la lista APIs, busca las herramientas de paginación como se muestra a continuación:

  3. Selecciona la cantidad de API que se mostrarán por página.
  4. Haz clic en > Forward para ir a la página siguiente.
  5. Haz clic en < Back para ir a la página anterior.

Próximos pasos