Pular para o conteúdo

Início rápido (5 minutos)

Objetivo: partir de uma instalação nova e chegar a um pedido autenticado cujo URL e cujo token vêm de variáveis. Conte cinco minutos.

Ficheiro ▸ Novo (Ctrl+N), depois Ficheiro ▸ Guardar como (Ctrl+Shift+S) para lhe dar um nome, por exemplo demo.restorm.

Um projeto é um simples ficheiro no seu disco. Pode colocá-lo num repositório git desde já — o Restorm foi feito para isso.

Clique com o botão direito na árvore lateral ▸ Adicionar ▸ Pasta de variáveis.

Uma pasta de variáveis (ou pasta de ambiente) é o contentor que alberga os seus ambientes — local, staging, production — e, portanto, as suas {{variables}}. Todos os pedidos que contém herdam o ambiente selecionado.

Abra-a, crie um ambiente local e adicione-lhe uma variável:

ChaveTipoValor
baseUrlCadeiahttps://api.exemple.test

O separador de uma pasta de variáveis, no seu subseparador Ambientes: o ambiente selecionado à esquerda e a sua variável baseUrl à direita

Clique com o botão direito na pasta ▸ Adicionar ▸ Pedido HTTP. No separador que se abre:

  • deixe o método em GET;
  • introduza o URL {{baseUrl}}/health — o valor resolvido aparece sob o campo, é a sua rede de segurança;
  • clique em Send.

A resposta abre-se abaixo: estado, tempo, tamanho, cabeçalhos e o corpo apresentado num visualizador JSON recolhível.

Um pedido HTTP cujo URL utiliza {{baseUrl}}, com o painel de resposta aberto à direita — estado, tempo, tamanho e corpo JSON

Em vez de colar um token fixo no código, crie um pedido de autenticação: clique com o botão direito ▸ Adicionar ▸ Pedido de autenticação. Configure a chamada que obtém o token (por exemplo um POST /oauth/token) e depois, no seu separador Configuração, declare o que ela produz:

Cabeçalho produzidoValor
Authorization{{token_type}} {{access_token}}

O valor é uma expressão avaliada sobre o corpo da resposta do pedido de autenticação. Aproveite para indicar a expressão de expiração (por exemplo {{expires_in}}) para que o Restorm renove o token por si só.

Volte ao seu pedido GET e, na barra superior, escolha essa rota de autenticação. O cabeçalho passa a ser injetado em cada envio, e um 401 desencadeia automaticamente uma renovação seguida de uma nova tentativa.

Detalhes: Autenticação.

  • Já tem uma especificação ou uma coleção? Ficheiro ▸ Importar (Ctrl+I) reconstrói a árvore completa: consulte Importação e exportação.
  • Encadeie várias chamadas e verifique os resultados com um cenário.
  • Execute esse cenário no seu CI: Execução headless.