Introducción a las dependencias

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

Vista previa — Apigee API hub

Esta función está sujeta a las "Condiciones de las Ofertas de Fase Previa a la DG" de la sección Condiciones Generales del Servicio de las Condiciones Específicas del Servicio. Las funciones de fase previa a la DG están disponibles “tal cual” y podrían tener asistencia limitada. Para obtener más información, consulta las descripciones de la etapa de lanzamiento.

Las dependencias del centro de APIs te ayudan a ver y administrar las relaciones entre las operaciones de API. Encontrar las dependencias de una API y hacerle un seguimiento te ayuda a administrar tu ecosistema de API de manera más eficiente. Por ejemplo, las dependencias pueden ayudarte a descubrir el impacto potencial de cambiar o dar de baja una API, solucionar problemas o analizar el cumplimiento de las regulaciones de costos o cumplimiento. Las APIs se pueden almacenar en el centro de APIs o de forma externa.

¿Qué es una dependencia?

El centro de APIs modela una dependencia como una relación direccional entre las operaciones de API, en la que una operación de API es el proveedor y la otra, el consumidor. Por ejemplo, supongamos que la API de PetStore llama a una operación en la API de ubicación. En este caso, la API de PetStore depende de una operación que proporciona la API de Ubicación. En el centro de APIs, nos referimos a PetStore como el consumidor y a la ubicación como proveedor.

Nota: Para la versión preliminar, el centro de APIs admite dependencias basadas en operaciones de API o APIs externas (APIs que no se almacenan en el centro de APIs). Puedes elegir qué tipo de dependencia cuando creas la dependencia.

La figura 1 ilustra la relación entre proveedor y consumidor entre las operaciones de la API. La operación /debit de la API de Payment consume la operación /detect de la API de Fraud Detection. La operación de débito es el consumidor y la operación de detección de fraudes es el proveedor en esta relación.

Del mismo modo, /detect consume operaciones proporcionadas por la API de UserProfile y la API de GeoLocation. En este caso, la operación /detect es el consumidor y los otros dos son los proveedores.

Figura 1. Asignación de dependencias de API

Crea una dependencia

Los pasos básicos para crear una dependencia en el centro de API son los siguientes:

1. Busca dos API que puedan tener dependencias de las que deseas realizar un seguimiento.
2. Genera una lista de las versiones de las dos API con la API de enumeración de versiones. También puedes usar la API de operaciones de lista y filtrar los resultados para encontrar operaciones dependientes.
3. Determina qué operación es el proveedor y cuál es el consumidor. Como se mencionó antes, la operación del consumidor invoca una operación del proveedor.
4. Usa la API de Create Dependency para crear la dependencia entre la operación de proveedor y la operación del consumidor.

Para obtener más detalles sobre cómo llamar a la API de Create Dependency y un ejemplo, consulta Crear dependencia de API.

Busca dependencias

La API de List Dependency es una buena forma de encontrar dependencias en el centro de APIs. La API te permite filtrar según atributos clave, incluidos el nombre de la operación de origen, el nombre de la operación de destino y el estado de la dependencia.

Los pasos básicos para encontrar dependencias son los siguientes:

1. Usa la API de List Dependency para enumerar todas las dependencias o usa la función de filtro de la API para limitar tu búsqueda.
2. Usa la API de Get Dependency para desglosar las dependencias dañadas y descubrir más detalles, como el nombre del proveedor.

Esta es un ejemplo de una llamada a la API para enumerar las dependencias:

curl "https://apihub.googleapis.com/v1/projects/myproject/locations/us-central1/dependencies"
    -H "Authorization: Bearer: $(gcloud auth print-access-token)" -X GET -H "Content-Type: application/json"

Identifica las dependencias dañadas

Para identificar dependencias dañadas, sigue estos pasos básicos:

1. Usa la API de List Dependency para enumerar todas las dependencias o usa la función de filtro de la API para limitar tu búsqueda.
2. Identifica cuáles de las dependencias que se muestran tienen configurada una marca de error.
3. Usa la API de Get Dependency para desglosar las dependencias dañadas y descubrir más detalles, como el nombre del proveedor.

   A continuación, se muestra una respuesta de muestra, en la que la condición de error indica que se quitó la operación del proveedor:

   {
     "name": "projects/common-dev-15/locations/us-central1/dependencies/user-to-pet",
     "consumer": {
         "displayName": "POST - /v2/user",
         "operationResourceName": "projects/common-dev-15/locations/us-central1/apis/payments-api/versions/2ff89c88-e8b6-48c4-a1c2-bdbb2a929bde/operations/createuser"
     },
     "supplier": {
         "displayName": "POST - /v2/pet",
         "operationResourceName": "projects/common-dev-15/locations/us-central1/apis/payments-api/versions/2ff89c88-e8b6-48c4-a1c2-bdbb2a929bde/operations/addpet"
     },
     "state": "VALIDATED",
     "description": "Dependency from user to pet API",
     "discoveryMode": "MANUAL",
     "createTime": "2024-04-17T19:33:31.215978712Z",
     "updateTime": "2024-04-17T19:33:31.737505297Z",
     {
       "error": "SUPPLIER_NOT_FOUND",
       "errorTime": 2024-05-18T20:23:42.465324Z
     }
   }

Otras operaciones de dependencia

Después de crear una dependencia, puedes usar las APIs del centro de APIs para obtener detalles de una dependencia, buscar dependencias mediante el filtrado de una lista de todas las dependencias en el centro de APIs, borrar una dependencia y actualizar su descripción. Todas las API de dependencia se describen en detalle en la referencia de la API y en Administra dependencias.