Criar uma API

Nesta página, descrevemos como criar uma API.

Pré-requisitos

Antes de criar uma API, faça o seguinte:

Requisitos do ID da API

Muitos dos comandos gcloud mostrados exigem que você especifique o ID da API, no formato: API_ID. A API Gateway aplica os seguintes requisitos aos IDs da API:

  • Os valores têm comprimento máximo de 63 caracteres.
  • Use somente letras minúsculas, números ou hifens
  • Não pode começar com um traço.
  • Não pode conter um sublinhado.

Criar uma API

Criar uma API.

Console doGoogle Cloud

Crie e implante uma API, conforme descrito em Implantar uma API em um gateway.

CLI do Google Cloud

Para criar uma API, consulte as seguintes seções:

Etapas para criar uma API

  1. Valide o ID do projeto retornado do seguinte comando para garantir que o serviço não seja criado no projeto incorreto.

    gcloud config list project

    Se você precisar mudar o projeto padrão, execute o seguinte comando e substitua PROJECT_ID pelo ID do projeto Google Cloud em que você quer criar o serviço:

    gcloud config set project PROJECT_ID

    Se o ID do projeto contiver dois pontos (:), consulte Projetos com escopo de domínio para mais detalhes sobre como criar uma API no projeto.

  2. Veja a ajuda do comando apis create:

    gcloud api-gateway apis create --help

  3. Execute este comando para criar a API:

    gcloud api-gateway apis create API_ID

    onde:

    Durante a criação da API, o gateway de API gera informações para o terminal.

  4. Após a conclusão, o comando a seguir pode ser usado para ver detalhes sobre a nova API:

    gcloud api-gateway apis describe API_ID

    Este comando mostra o seguinte:

          createTime: '2020-02-29T21:52:20.297426875Z'
      displayName: API_ID
      managedService: MANAGED_SERVICE_NAME.apigateway.PROJECT_ID.cloud.goog
      name: projects/PROJECT_ID/locations/global/apis/API_ID
      state: ACTIVE
      updateTime: '2020-02-29T21:52:20.647923711Z'

Opções da Google Cloud CLI

A CLI do Google Cloud usa muitas opções, incluindo as descritas na referência do gcloud. Além disso, para o gateway de API, é possível definir as seguintes opções ao criar uma API:

  • --async: retorna o controle para o terminal imediatamente, sem aguardar a conclusão da operação.
  • --display-name=NAME: especifica o nome de exibição da API, o que significa o nome mostrado na UI. Não use espaços no nome. Use hifens e sublinhados. O valor padrão é API_ID.
  • --labels=KEY1=VALUE1,KEY2=VALUE2,...: especifica rótulos associados à configuração da API.
  • --managed-service: especifica um serviço gerenciado preexistente para a API. Consulte também Projetos com escopo de domínio

Projetos de escopo de domínio

Se o projeto tiver escopo para seu domínio, o ID do projeto incluirá o nome do domínio seguido por dois pontos (:), por exemplo, example.com:my-project. É preciso fornecer um serviço gerenciado válido ao criar uma API em um projeto com escopo de domínio.

Se estiver usando gcloud, forneça o nome do serviço gerenciado com a flag --managed-service, conforme descrito em opções da Google Cloud CLI.

Listar APIs

Liste todas as APIs em um projeto.

Console doGoogle Cloud

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

Acessar o gateway de API

CLI do Google Cloud

gcloud api-gateway apis list

Esse comando retorna a saída no formato:

  NAME                                              DISPLAY_NAME  MANAGED_SERVICE                          STATE
  projects/PROJECT_ID/locations/global/apis/API_ID  API_ID        MANAGED_SERVICE_NAME.apigateway.PROJECT_ID.cloud.goog  ACTIVE

Use o ID da API para receber informações detalhadas sobre ela:

gcloud api-gateway apis describe API_ID

Atualizar uma API

Após a criação, é possível atualizar os rótulos e o nome de exibição de uma API.

Console doGoogle Cloud

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

    Acessar o gateway de API

  2. Clique na API necessária.
  3. Clique na guia Detalhes.
  4. Clique em edit Editar.
  5. Edite o Nome de exibição ou os Rótulos e clique em Salvar.

CLI do Google Cloud

Use as seguintes opções de gcloud para atualizar uma API:

  • --display-name
  • --update-labels
  • --clear-labels
  • --remove-labels

Exemplo:

  gcloud api-gateway apis update API_ID \
    --update-labels=a=1,b=2

Use o seguinte comando para ver todas as opções de atualização:

gcloud api-gateway apis update --help

Excluir uma API

Para excluir uma API, você precisa:

  • Exclua os gateways de API associados à API e às configurações dela.
  • Exclua as configurações associadas à API.
  • Exclua a API:

Console doGoogle Cloud

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

    Acessar o gateway de API

  2. Clique na API escolhida para ser excluída.
  3. Clique na guia Configurações.
  4. Selecione as configurações de API e clique em Mais e em Excluir.
  5. Clique em para voltar à página inicial do gateway de API.
  6. Clique em Mais e em Excluir para excluir a API escolhida.

CLI do Google Cloud

  1. Determine a lista de gateways de API associados à API:

    gcloud api-gateway gateways list --filter='apiConfig:"projects/PROJECT_ID/locations/global/apis/API_ID"'

  2. Exclua cada configuração de API associada a ela:

    gcloud api-gateway api-configs delete CONFIG_ID --api=API_ID

  3. Exclua a API:

    gcloud api-gateway apis delete API_ID

A seguir