Como testar a API

Além de visualizar a documentação de referência da API SmartDocs, os desenvolvedores podem usar o painel Testar esta API para interagir com a API sem sair da respectiva documentação. No portal, os desenvolvedores podem enviar solicitações para a API e ver as respostas. Testar a API no portal ajuda seus usuários a entender o que precisam fazer para que o código deles funcione com a API.

Se a API precisar de uma chave de API ou de autenticação, será necessário configurar o portal de modo a permitir que os usuários interajam com a API. Nesta página, descrevemos os requisitos e a configuração necessária para que os desenvolvedores usem o painel Testar esta API. O papel do Cloud Identity and Access Management mínimo exigido é fornecido para a conclusão de cada tarefa. Para mais informações sobre as permissões do Cloud IAM, consulte estes artigos:

Pré-requisitos

Como definir as configurações do API Explorer

Se a API exigir uma chave de API e/ou autenticação do Firebase ou Auth0, você precisará definir essas configurações para que os usuários possam testá-la. Nesta seção, descrevemos como definir uma chave de API e as configurações de autenticação.

Como configurar uma chave de API

Para configurar uma chave de API no seu portal, siga estas instruções:

  1. No Console do Google Cloud Platform, acesse APIs e serviços > Credenciais.

    Acesse a página "Credenciais"

  2. Na lista suspensa Projeto, na parte superior da janela do Console do GCP, selecione o projeto do GCP em que você criou a API.

    • Se você já tem uma chave de API e quer usá-la, siga estas etapas:

      1. Clique em Editar chave de API edit ao lado da chave que você quer usar.
      2. À direita da chave de API, clique em Copiar content_copy para copiá-la para a área de transferência.
      3. Clique em Cancelar.
    • Se você precisar criar uma chave de API, siga estas etapas:

      1. Clique em Criar credenciais e, em seguida, selecione Chave de API.
      2. Copie a chave para a área de transferência.
      3. Clique em Fechar.
  3. Volte para o portal.

  4. Clique em Configurações settings.

  5. Clique na guia APIs e selecione sua API na lista suspensa.

  6. Na seção Configurações do APIs Explorer, cole a chave de API no campo Chave de API do Google.

  7. Clique em Salvar.

Como configurar o Firebase

Para configurar o Firebase, siga estas etapas:

  1. Abra o console do Firebase.

    • Se você não tiver um projeto do Firebase, siga as etapas abaixo:

      1. Clique em Adicionar projeto e selecione o nome do projeto do GCP em que a API está.
      2. No cartão Autenticação, clique em Primeiros passos.
      3. Clique na guia Método de login.
      4. Na seção Provedores de login, ative os provedores que você quer usar.
      5. Na seção Domínios autorizados, clique em Adicionar domínio e inclua o nome de domínio do portal. Por exemplo, endpointsportal.example-api.example.com.
      6. Clique em Configuração da Web. O snippet de código personalizado é exibido. Como você precisará usar as informações do snippet nas etapas a seguir, mantenha o Console do Firebase aberto.
    • Se você já tiver um projeto do Firebase, siga estas etapas:

      1. Acesse Desenvolver > Autenticação.
      2. Clique na guia Método de login.
      3. Na seção Domínios autorizados, clique em Adicionar domínio e inclua o nome de domínio do portal. Por exemplo, endpointsportal.example-api.example.com.
      4. Clique em Configuração da Web. O snippet de código personalizado é exibido. Como você precisará usar as informações do snippet nas etapas a seguir, mantenha o Console do Firebase aberto.
  2. Abra outra guia no navegador e acesse o portal.

  3. Clique em Configurações settings.

  4. Na página Configurações, clique na guia APIs e selecione sua API na lista suspensa.

  5. Siga estas etapas na seção Configurações do APIs Explorer:

    1. Copie o valor do campo apiKey do snippet de código do Firebase e cole-o no campo Chave de API do Google.
    2. Copie o valor do campo authDomain do snippet de código do Firebase e cole-o no campo Domínio de autenticação do Firebase.
  6. Clique em Salvar.

Consulte a documentação do Firebase para mais informações.

Como configurar o Auth0

Use a seguinte lista geral de tarefas para configurar o Auth0 e seu portal:

Tarefa 1: verificar se há uma API Auth0 para o serviço do Cloud Endpoints.

Tarefa 2: configurar o aplicativo do Auth0.

Tarefa 3: configurar o Auth0 no portal.

Tarefa 1: verificar se há uma API Auth0 para o serviço do Cloud Endpoints

  1. Faça login no painel do Auth0.
  2. Na barra de navegação à esquerda, clique em APIs. Se houver um público de API na forma de https://SERVICE_NAME, em que SERVICE_NAME é o nome do serviço do Endpoints, você já criou uma API. Continue com a próxima tarefa para definir as configurações do aplicativo do Auth0.

    Caso contrário, crie uma API:

    1. Clique em + Criar API.
    2. Insira um nome.
    3. No campo Identificador, insira um URL no formato https://SERVICE_NAME.

      Substitua SERVICE_NAME pelo nome do serviço do Endpoints. Consulte Como conseguir o nome e o código de configuração do serviço se você não souber o nome do serviço do Endpoints.

    4. Clique em Criar.

Tarefa 2: configurar o aplicativo do Auth0

  1. No Painel do Auth0, clique em Aplicativos na barra de navegação à esquerda.
  2. Selecione seu aplicativo do Auth0 ou clique em + Criar aplicativo para criar um novo.
  3. Na guia Configurações do aplicativo, role para baixo e adicione o URL do portal (por exemplo, https://endpointsportal.example-api.example.com) aos seguintes campos:

    • URLs de callback permitidos
    • Origens da Web permitidas

    Esses campos aceitam vários URLs separados por vírgula. Verifique se o URL inserido não inclui o caractere / à direita.

    1. Clique em Salvar alterações.

    Como você precisará dessas informações nas etapas a seguir, mantenha a guia do navegador Configurações do Auth0 aberta.

Tarefa 3: configurar o Auth0 no portal

  1. Abra outra guia no navegador e acesse o portal.
  2. Clique em Configurações settings.
  3. Na página Configurações, clique na guia APIs e selecione sua API na lista suspensa.
  4. Siga estas etapas na seção Configurações do APIs Explorer:

    1. Copie o valor do campo ID do cliente no Painel do Auth0 e cole-o no campo ID do cliente do Auth0.
    2. Copie o valor do campo Domínio no Painel do Auth0 e cole-o no campo Domínio do Auth0.
  5. Clique em Salvar.

Para mais informações sobre como configurar o Auth0, consulte Visão geral do Painel do Auth0 (em inglês) na documentação do Auth0.

Esta página foi útil? Conte sua opinião sobre:

Enviar comentários sobre…

Cloud Endpoints com gRPC
Precisa de ajuda? Acesse nossa página de suporte.