Visão geral dos recursos da API

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

Ao registrar uma API no hub de API, você cria e armazena uma entidade que representa a API. Chamamos essa entidade de recurso de API. Os recursos da API armazenados no hub da API são pesquisáveis e fornecem informações operacionais e descritivas detalhadas sobre a API.

Um recurso de API é uma entidade complexa que pode ter uma ou mais versões associadas. A versão pode ser considerada o estado de uma API em um determinado momento. Cada versão pode ter o próprio conjunto de entidades, como operações analisadas de uma especificação de API, implantações e especificações de API, conforme mostrado na Figura 1.

Relacionamentos de entidades da API.

Figura 1. Uma API pode ter várias versões.

No momento em que você registra uma API ou depois, é possível adicionar e editar atributos de recursos da API para criar uma descrição detalhada da API. Consulte Gerenciar atributos.

O hub de APIs permite atributos definidos pelo sistema e pelo usuário. Veja a seguir exemplos de atributos definidos pelo sistema:

  • Estilo da API: um atributo com valores padrão da API Async, REST, gRPC e SOAP.
  • Usuários-alvo: usuários (consumidores) pretendidos de uma API.
  • Equipe: a equipe de produção ou equipes responsáveis por uma API
  • Unidade de negócios: a unidade de negócios responsável por uma API
  • Nível de maturidade: uma indicação do estágio do ciclo de vida da API.

Por fim, um recurso de API pode ter atributos definidos pelo usuário, que você define em "Configurações" com base nas necessidades da sua organização ou equipe.