Declarar dependências

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

Os painéis a seguir aparecem na parte inferior da página Visão geral da API, que usa links para indicar informações relacionadas à API:

  • Temas relacionados: informações diversas relacionadas à API
  • Dependências: todas as dependências da API que podem ser relevantes, incluindo APIs internas, APIs externas de terceiros e outros sistemas de produção
Dependências, clique para ampliar a imagem

É possível definir várias seções ou tipos de links relacionados. Esses tipos usam uma taxonomia de sistema, que pode ser modificada para dar mais flexibilidade à estrutura organizacional. Um elemento de taxonomia especial é definido pelo sistema para que seja possível especificar somente as dependências internas de API. Dessa forma, o sistema pode inferir as relações de dependência da API em todo o hub de APIs.

O painel Temas relacionados exibe links para informações diversas relacionadas à API. Por exemplo, repositório de código-fonte, documentação de design ou sistemas de infraestrutura.

Todas as informações no painel Temas relacionados são definidas manualmente. Você pode adicionar, editar, excluir e ordenar Informações relacionadas.

Siga estas etapas para adicionar itens ao painel Temas relacionados:

  1. No console do Google Cloud, acesse a página Hub de APIs.

    Acesse o hub de API

    A página da lista APIs é exibida por padrão.

  2. Na lista APIs, clique em uma linha da API. A guia Visão geral é exibida por padrão.
  3. No painel Temas relacionados, clique em Editar.
  4. Especifique:
    • Código-fonte:
      1. Clique em Adicionar código-fonte.
      2. Especificar um nome
      3. Especifique um URL.

    • Exemplo de APIs da organização:

      1. Clique em Adicionar exemplo de API da organização.
      2. Selecione uma API na lista.
    • Outros:
      1. Clique em Adicionar outro.
      2. Especifique um Nome para a API.
      3. Especifique um URL a ser usado para chamadas de API.
  5. Clique em Salvar ou Cancelar.

Para editar itens no painel Temas relacionados:

  1. No console do Cloud, acesse a página Hub de APIs.

    Acesse o hub de API

    A página da lista APIs é exibida por padrão.

  2. Na lista APIs, clique em uma linha da API. A guia Visão geral é exibida por padrão.
  3. No painel Temas relacionados, clique em Editar.
  4. Faça as modificações necessárias.
  5. Clique em Salvar ou Cancelar.

Para excluir itens do painel Temas relacionados:

  1. No console do Cloud, acesse a página Hub de APIs.

    Acesse o hub de API

    A página da lista APIs é exibida por padrão.

  2. Na lista APIs, clique em uma linha da API. A guia Visão geral é exibida por padrão.
  3. No painel Temas relacionados, clique em Editar.
  4. Clique em Excluir ao lado do tipo de taxonomia desejada.
  5. Clique em Excluir (ou Cancelar) na caixa de diálogo de confirmação.
  6. Clique em Salvar ou Cancelar.

Para pedir itens no painel Temas relacionados:

  1. No console do Cloud, acesse a página Hub de APIs.

    Acesse o hub de API

    A página da lista APIs é exibida por padrão.

  2. Na lista APIs, clique em uma linha da API. A guia Visão geral é exibida por padrão.
  3. No painel Temas relacionados, clique em Editar.
  4. Clique em Mover para baixo ou Mover para cima ao lado do item desejado.
  5. Clique em Salvar ou Cancelar.

Dependências

O painel Dependências lista todas as dependências da API, incluindo outras APIs internas, presentes no hub de APIs, APIs externas de terceiros, não presentes no hub de APIs, e outros sistemas de produção, por exemplo, bancos de dados e soluções de armazenamento.

Todas as informações no painel Dependências são definidas manualmente. Você pode adicionar, editar, excluir e ordenar Dependências.

Adicionar dependência

Para adicionar ao painel Dependências:

  1. No console do Cloud, acesse a página Hub de APIs.

    Acesse o hub de API

    A página da lista APIs é exibida por padrão.

  2. Na lista APIs, clique em uma linha da API. A guia Visão geral é exibida por padrão.
  3. No painel Dependências, clique em Editar.
  4. Especifique:

    • Exemplo de APIs da organização:

      1. Clique em Adicionar exemplo de API da organização.
      2. Selecione uma API na lista.
    • APIs de terceiros:
      1. Clique em Adicionar APIs de terceiros.
      2. Especifique um Nome para a API.
      3. Especifique um URL a ser usado para chamadas de API.
    • Outros:
      1. Clique em Adicionar outro.
      2. Especifique um Nome para a API.
      3. Especifique um URL a ser usado para chamadas de API.
  5. Clique em Salvar ou Cancelar.

Editar dependência

Para editar o painel Dependências:

  1. No console do Cloud, acesse a página Hub de APIs.

    Acesse o hub de API

    A página da lista APIs é exibida por padrão.

  2. Na lista APIs, clique em uma linha da API. A guia Visão geral é exibida por padrão.
  3. No painel Dependências, clique em Editar.
  4. Faça as modificações necessárias.
  5. Clique em Salvar ou Cancelar.

Excluir dependência

Para excluir um item do painel Dependências:

  1. No console do Cloud, acesse a página Hub de APIs.

    Acesse o hub de API

    A página da lista APIs é exibida por padrão.

  2. Na lista APIs, clique em uma linha da API. A guia Visão geral é exibida por padrão.
  3. No painel Dependências, clique em Editar.
  4. Clique em Excluir ao lado do tipo de taxonomia desejada.
  5. Clique em Excluir (ou Cancelar) na caixa de diálogo de confirmação.
  6. Clique em Salvar ou Cancelar.

Dependências de pedido

Para ordenar itens no painel Dependencies:

  1. No console do Cloud, acesse a página Hub de APIs.

    Acesse o hub de API

    A página da lista APIs é exibida por padrão.

  2. Na lista APIs, clique em uma linha da API. A guia Visão geral é exibida por padrão.
  3. No painel Dependências, clique em Editar.
  4. Clique em Mover para baixo ou Mover para cima ao lado do item desejado.
  5. Clique em Salvar ou Cancelar.