Começar a usar o gateway de API e o hub de APIs

Neste tutorial, mostramos como conectar o gateway de API ao Hub de API para permitir a publicação perfeita de metadados de API do projeto do gateway de API no Hub de API.

Neste tutorial, você vai usar o console Google Cloud .

Lista de tarefas

Ao seguir o tutorial, use a lista de tarefas abaixo. Todas as tarefas são necessárias para conectar o gateway de API ao hub de APIs.

  1. Siga as etapas de pré-requisito descritas em Antes de começar.

  2. Implante uma API no gateway de API.

  3. Anexe seu projeto do gateway de API ao hub de APIs.

  4. Confira a API do gateway de API no hub de APIs.

  5. Ver seu gateway MCP no hub de APIs.

  6. Evite cobranças na sua conta do Google Cloud. Consulte Limpeza.

Antes de começar

Antes de começar, verifique se você concluiu as seguintes etapas de pré-requisito:

  1. Configure o gateway de API no seu projeto.

  2. Configure o hub de API no projeto host.

Configurar o gateway de API no projeto

Para configurar o gateway de API no seu projeto, faça o seguinte:

  1. No console do Google Cloud , acesse a página Gateway de API.

    Acessar o gateway de API

  2. O gateway de API requer a ativação dos seguintes serviços do Google:

    Nome Nome
    apigateway.googleapis.com API Gateway API
    servicemanagement.googleapis.com API Service Management
    servicecontrol.googleapis.com API Service Control

    Se você ainda não tiver ativado esses serviços para o projeto selecionado, será solicitado que faça isso.

  3. Confirme se o faturamento está ativado no projeto.

    Saiba como ativar o faturamento

Configurar o hub de API no projeto host

  1. Crie ou selecione um projeto do Google Cloud para usar como projeto host.

    Um projeto host é um projeto do Google Cloud na sua organização Google Cloud que você designa como o projeto do consumidor para todos os recursos do hub de APIs. Só uma instância do hub de APIs pode ser provisionada por projeto host.

    Para oferecer descoberta centralizada de APIs em todos os gateways de API, recomendamos usar um projeto host dedicado para a instância do hub de APIs e anexar vários projetos do gateway de API, chamados de projetos de tempo de execução, à instância do hub de APIs.

  2. Conceda os papéis do Identity and Access Management (IAM) necessários para conectar o API Gateway ao API Hub.

  3. Provisione o hub de API no projeto host.

Implantar uma API no gateway de API

Conclua o guia de início rápido do gateway de API para implantar um serviço "hello world" do Cloud Run e criar um gateway que aponte para esse serviço.

Por exemplo, a API helloworld é implantada no Gateway de API helloworld-gateway, conforme mostrado na página "Gateways" em Google Cloud console.

API helloworld hospedada no gateway helloworld-gateway

Anexe seu projeto do gateway de API ao hub de APIs

Para anexar seu projeto do gateway de API ao hub de API, faça o seguinte:

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

    Acesse o hub de API

  2. Selecione o projeto host do hub de API no menu suspenso.
  3. Clique em Configurações no menu de navegação à esquerda para abrir a página Configurações.
  4. Acesse a guia Associações de projetos.
  5. Clique em Anexar projeto de ambiente de execução.
    O painel Selecionar um recurso vai aparecer.
  6. Clique no projeto Google Cloud em que o gateway de API está provisionado.
  7. No painel Configurações de associação de projeto, selecione gateway de API e outros recursos de API que você quer importar automaticamente.
  8. Clique em Salvar.

Seu projeto de ambiente de execução é anexado e exibido na lista de projetos anexados no console do Google Cloud .

Exemplo:

Projeto myproject anexado como um projeto de ambiente de execução no hub de API

Ver a API do gateway de API no hub de API

Para ver sua API do gateway de API no hub de API, faça o seguinte:

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

    Acesse o hub de API

  2. Localize a API "hello world" implantada no gateway de API.

    Se necessário, selecione Gateway: gateway de API no menu suspenso Filtro para mostrar apenas as APIs do gateway de API.

    Exemplo:

    API helloworld exibida na página "APIs" no hub

  3. Clique na API para ver mais detalhes, incluindo os metadados da API.

Ver o gateway MCP no hub de APIs

Se a API do gateway de API estiver configurada como um servidor do Protocolo de Contexto de Modelo (MCP), o hub de API vai adicionar uma segunda entrada para ela, chamada <your-api> (MCP). Consulte Descoberta pelo hub de APIs e pelo Agent Registry na visão geral do MCP.

Somente os gateways com o MCP ativado vão mostrar essas entradas adicionais no Hub de API.

Para conferir os detalhes do gateway do MCP no hub de APIs:

  1. No console do Google Cloud , acesse a página APIs no Hub de APIs.
  2. Localize a entrada chamada <your-api> (MCP).
  3. Clique na API para conferir os detalhes, incluindo metadados e ferramentas específicos do MCP.

Por exemplo, a API helloworld (MCP) aparece ao lado da API helloworld padrão no hub de APIs:

APIs helloworld e helloworld (MCP) no hub de APIs

Também é possível ver esse servidor MCP no Agent Registry. Os agentes podem descobrir o servidor e as ferramentas dele automaticamente por qualquer um dos catálogos.

Por exemplo, o servidor MCP aparece na guia Servidores MCP do Agent Registry:

Servidores MCP no Agent Registry

Limpar

Para evitar cobranças na sua conta do Google Cloud pelos recursos usados neste tutorial, faça o seguinte:

Como alternativa, também é possível excluir os Google Cloud projetos usados neste tutorial.

A seguir