Registrar uma API

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

Nesta página, mostramos como registrar uma API no Hub de API.

Antes de começar

  1. O hub de APIs precisa ser provisionado em um projeto do Google Cloud a que você tem acesso. Consulte Provisionar hub da API.
  2. No console do Google Cloud, na página do seletor de projetos, selecione o projeto em que o hub de APIs está provisionado.

    Acessar o seletor de projetos

Registrar uma API

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. Para saber mais, consulte a Visão geral dos recursos da API.

  1. No console do Google Cloud, acesse a página APIs no hub de APIs da Apigee.

    Acesse o hub de API
  2. Clique em API de registro. O formulário Registrar uma API é exibido.
  3. Na seção Detalhes gerais do formulário, digite um nome de exibição. O nome de exibição é simplesmente um nome de sua escolha que vai aparecer na interface do usuário depois que você registrar a API. Esse atributo é obrigatório.
  4. Clique em Continuar.
  5. O formulário Informações do proprietário é aberto.
  6. Os campos de informações do proprietário são opcionais. Por enquanto, deixe em branco e clique em Continuar.
  7. O formulário Mais detalhes é aberto.
  8. No campo Descrição, digite uma breve descrição da API. O campo "Description" (Descrição) é opcional.
  9. Pule os campos restantes e clique em Continuar.
  10. O formulário Atributos definidos pelo usuário é aberto.
  11. Informe valores para qualquer um dos atributos que você quiser. Se não houver atributos, isso significa que nenhum foi criado ainda. Consulte Criar atributos definidos pelo usuário.
  12. Pule Métricas da API.
  13. Clique em Registrar.

Você criou um recurso de API no Hub de API. Você sempre pode retornar a um recurso de API para editá-lo mais tarde.

Mais detalhes da API

Depois de registrar uma API, você pode ver os detalhes dela.

  1. No console do Google Cloud, acesse a página APIs no hub de APIs da Apigee.

    Acesse o hub de API
  2. Encontre a API que você acabou de registrar na lista. Se ela não aparecer, digite o nome da API no Filtro.
  3. Clique no nome da API para ver os detalhes.

No próximo guia de início rápido, você vai criar uma versão para a API.

Próxima etapa

Criar uma versão