Introdução às dependências

Esta página se aplica à Apigee e à Apigee híbrida.

As dependências do hub de APIs ajudam você a ver e gerenciar as relações entre as operações de API. Encontrar e monitorar as dependências de uma API ajuda você a gerenciar seu ecossistema de APIs com mais eficiência. Por exemplo, as dependências podem ajudar você a descobrir o possível impacto da alteração ou descontinuação de uma API, resolver problemas ou analisar a adesão aos regulamentos de custo ou conformidade. As APIs podem ser armazenadas dentro do hub de APIs ou fora dele.

O que é uma dependência?

O hub de APIs modela uma dependência como uma relação direcional entre as operações de API, em que uma operação de API é a fornecedora e a outra é a consumidora. Por exemplo, digamos que a API PetStore chame uma operação na API Location. Nesse caso, a operação depende de uma operação fornecida pela API Location. No hub de APIs, nos referimos à PetStore como a consumidora e à Location como a fornecedora.

Observação: o hub de APIs aceita dependências com base em operações de API ou APIs externas (que não são armazenadas no hub de APIs). É possível escolher que tipo de entidade usar (operação ou API externa) ao criar a dependência.

A Figura 1 ilustra a relação fornecedor/consumidor entre as operações de API. A operação /debit da API Payment consome a operação /detect da API Fraud Detection. Nessa relação, a operação de débito é a consumidora e a operação de detecção de fraudes é a fornecedora.

Da mesma forma, /detect consome operações fornecidas pela API UserProfile e pela API GeoLocation. Nesse caso, a operação /detect é a consumidora, e as outras duas são as fornecedoras, conforme mostrado na Figura 1.

Figura 1. A interface de dependências permite que você visualize pares de consumidores/fornecedores e detalhe as informações de cada relação de dependência.

Criar uma dependência

É possível criar uma dependência entre operações de API adicionadas ao hub de APIs usando uma especificação de API enviada ou uma API externa.

As etapas básicas para criar uma dependência no hub de APIs são:

1. Encontre duas APIs que possam ter operações dependentes. As operações podem estar em APIs registradas ou APIs externas.
2. Determinar qual operação é a fornecedora e qual é a consumidora. Conforme discutido anteriormente, o consumidor invoca o fornecedor.
3. Use a interface ou a API Create Dependency para criar a dependência entre o fornecedor e o consumidor.

Consulte Criar uma dependência.

Avançar

Gerenciar dependências