Ir para o conteúdo

Fonte de Dados REST

Visão Geral

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

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

Servidor de Fonte de Dados REST

A configuração do servidor de origem 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
  • Digite um Nome do servidor
  • Selecione o tipo REST API em serviços da Web

  • Digite a URL do servidor para se conectar

    Nota

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

    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 cabeçalho da solicitação. Configure o cabeçalho da solicitação 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 Web Service, clique em + Parâmetro
    • Selecione Cabeçalho como o tipo
    • Adicione o Nome do parâmetro de cabeçalho
      • Por exemplo, para servidores Vinyl REST, a chave da API é passada usando "X-API-Key"
  • Adicione o Valor do parâmetro de cabeçalho
  • Clique no ícone da marca de seleção para salvar

Configurar Parâmetros de String de Consulta

Se você tiver parâmetros de string de consultar comuns para usar nos terminais, 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 Web Service, clique em + Parâmetro
    • Selecione Consulta como o tipo
    • Adicione o Nome do parâmetro da string de consultar
    • Adicione o Value do parâmetro da string de consultar
  • Clique no ícone da marca de seleção para salvar

Endpoints REST

Depois que seu servidor de dados REST tiver sido 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 URL do servidor de dados REST
      • Por exemplo, se o URL do nosso servidor de dados REST estiver definido como https://api.google.com/rest/v1, um endpoint de "analítica" 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 do endpoint Response ou Request, clique em More e selecione Edge Case
    • Na seção Tipo de Conteúdo existem 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 da resposta do servidor
    • O valor padrão para Solicitação e Resposta não está definido e será herdado do tipo de conteúdo do servidor. Os valores de Tipo de Conteúdo incluem Arquivo, JSON, Multipart, Texto Simples e XML.
  • Clique em Salvar
  • Clique em Discover para revisar a consultar proposta e clique em Discover 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 Continuar para chamar o endpoint. Se parâmetros de entrada forem definidos, seu valor de teste será enviado.

Recursos