Ir para o conteúdo

Fonte de Dados REST

Visão Geral

A fonte de dados REST fornece aos desenvolvedores a capacidade de conectar App Builder para vários servidores REST, incluindo outras instâncias de App Builder. A configuração de uma fonte de dados REST envolve três etapas básicas:

  1. Criando e configurando o servidor de fonte de dados REST
  2. Criando endpoints REST para cada método de API que você chamará
  3. Para APIs estilo REST CRUD, opcionalmente criando um superobjeto REST

Servidor de Fonte de Dados REST

A configuração do Servidor de Fonte de Dados REST contém informações que são usadas em todos os endpoints REST.

Crie o Servidor de Dados REST

  • Navegue até IDE > Servidores de dados
  • Clique em + Servidor
  • Insira um Nome do Servidor
  • Selecione o tipo REST API em Serviços da Web

  • Digite a URL do servidor para conectar

    Nota

    Os Endpoints que você configurar na próxima seção serão anexados a esta URL principal. Se assumirmos um endpoint de servidor REST de https://api.google.com/rest/v1/analytics a configuração poderia ser assim:

    URL do servidor: https://api.google.com/rest/v1 Endpoint: analytics

  • Insira o tipo de conteúdo da solicitação e da resposta. Normalmente, os servidores REST se comunicam via JSON

  • Insira Configurações de segurança, se necessário
    • A maioria das APIs REST usa uma chave de API no cabeçalho que configuramos em uma seção posterior
  • Clique em Salvar e feche a caixa de diálogo

Você deverá ver seu Servidor de Dados REST na lista de Servidores de Dados.

Configurar Cabeçalhos de Solicitação

A maioria dos serviços REST exige que você passe uma chave de API usando o request cabeçalho. Configure o request cabeçalho da seguinte forma:

  • Navegue até IDE > Servidores de dados
  • Clique no botão Detalhes do Servidor de Dados que você configurou
  • No painel Parâmetros do serviço da Web, clique em + Parâmetro
    • Selecione Cabeçalho como o Tipo
    • Adicione o Nome do parâmetro de cabeçalho
      • Por exemplo, para App Builder servidores REST a chave da API é passada usando "X-API-Key"
  • Adicione o Valor do parâmetro do cabeçalho
  • Clique no ícone de marca de seleção para salvar

Configurar Parâmetros de Sequência de Consultar

Se você tiver parâmetros de string de consultar comuns para usar em todos os pontos de extremidade, poderá configurá-los da seguinte maneira:

  • Navegue até IDE > Servidores de dados
  • Clique no botão Detalhes do Servidor de Dados que você configurou
  • No painel Parâmetros do serviço da Web, clique em + Parâmetro
    • Selecione Consulta como o Tipo
    • Adicione o Nome do parâmetro da string de consultar
    • Adicione o Valor do parâmetro da string de consultar
  • Clique no ícone de marca de seleção para salvar

Endpoints REST

Depois que seu servidor de dados REST estiver configurado, você poderá adicionar endpoints de API.

Adicionar um Endpoint

  • Navegue até IDE > Servidores de dados
  • Clique no botão Detalhes do Servidor de Dados que você configurou
  • No painel Endpoints, clique em + Endpoint
    • Insira o Nome do Endpoint
    • Insira o Endpoint. Este valor é anexado ao REST Data Server URL
      • Por exemplo, se o URL do nosso servidor de dados REST estiver definido como https://api.google.com/rest/v1, um endpoint de "analytics" resultará no seguinte URL: https://api.google.com/rest/v1/analytics
  • Selecione o método HTTP para o endpoint
  • Se você quiser substituir o tipo de conteúdo Resposta ou Solicitação do endpoint, clique em Mais e selecione Caso extremo
    • Na seção Tipo de conteúdo há dois campos disponíveis para esta configuração:
      • Solicitação: O valor selecionado substituirá o tipo de conteúdo da solicitação do servidor
      • Resposta: O valor selecionado substituirá o tipo de conteúdo de resposta do servidor
    • O valor padrão para Request e Response não é definido e será herdado do tipo de conteúdo do servidor. Os valores do Content Type incluem File, JSON, Multipart, Plain Text e XML.
  • Clique em Salvar
  • Clique em Descobrir para revisar a consultar proposta e clique em Descobrir novamente para executar a consultar
    • Isso irá gerar parâmetros de entrada para qualquer entrada de amostra inserida
    • Além disso, tabelas de saída serão geradas para quaisquer dados retornados do endpoint
  • Clique em Testar conexão e depois em Prosseguir para chamar o endpoint. Se os parâmetros de entrada forem definidos, seu valor de teste será enviado.

Recursos