Pular para o conteúdo

HTTP e REST

O tipo de pedido mais corrente: tudo o que fala HTTP, a começar pelas API REST.

Clique com o botão direito na árvore ▸ Adicionar ▸ Pedido HTTP.

Um separador de pedido HTTP com o URL, as secções Cabeçalhos / Parâmetros de caminho / Parâmetros / Corpo e o painel de resposta à direita

GET, POST, PUT, PATCH, DELETE, HEAD, OPTIONS e QUERY.

O URL aceita {{variables}} em qualquer sítio — esquema, anfitrião, porta, caminho, cadeia de consulta. O valor resolvido é apresentado sob o campo.

Três listas completam o URL:

  • os parâmetros de consulta (?key=value);
  • os parâmetros de caminho, que substituem os segmentos nomeados do caminho;
  • os cabeçalhos.

Cada linha tem uma caixa de verificação para a ativar, um tipo de valor e uma descrição.

Quatro famílias:

TipoUtilização
TextoJSON, XML, texto simples — com realce de sintaxe e reformatação
FicheiroEnvia o conteúdo de um ficheiro do disco
Formulário (multipart/form-data)Campos nomeados, com ficheiros
x-www-form-urlencodedCampos nomeados codificados no corpo
  • Tempo limite: em milissegundos, específico deste pedido; na sua ausência, aplica-se o valor global.
  • Seguir redirecionamentos: ativado por predefinição. Desative-o para observar o próprio 3xx e o respetivo cabeçalho Location.

Estado, tempo, tamanho, cabeçalhos e o corpo apresentado conforme o seu tipo de conteúdo: visualizador JSON recolhível, XML indentado, pré-visualização de imagem, texto simples. O separador de histórico dá acesso às execuções anteriores.

Associe uma rota de autenticação ao pedido para que os cabeçalhos sejam injetados e o token renovado automaticamente. Consulte Autenticação.

O Restorm também sabe alojar um servidor HTTP, para testar a forma como um cliente o consome — tipicamente o código da sua aplicação, que aponta para localhost durante um ensaio.

Adicione um com Adicionar ▸ Servidor HTTP: fica à escuta em localhost:<port><path> para um par método + caminho e responde com o estado, os cabeçalhos e o corpo que aí configurar. Os outros protocolos alojam-se da mesma maneira — consulte Modo servidor e Simular uma API HTTP.

O separador Code Snippets propõe vinte e quatro linguagens e bibliotecas: cURL, JavaScript (Fetch, Axios), TypeScript, Python (Requests, http.client, aiohttp), Node.js nativo, Go, Rust (reqwest), Java (HttpClient, OkHttp), C# (HttpClient), PHP (cURL, Guzzle), Ruby (Net::HTTP, Faraday), Swift (URLSession), Kotlin (OkHttp), Dart, R (httr), PowerShell, Elixir (HTTPoison), Clojure (clj-http).

Tem uma especificação OpenAPI, uma coleção Postman, um ficheiro HAR ou um simples comando curl? Ficheiro ▸ Importar reconstrói a árvore por si. Consulte Importação e exportação.