Se você está trabalhando com APIs, pode ser necessário fazer uma requisição put em Node.js. Uma requisição put é uma forma de atualizar ou modificar um recurso existente em um servidor. Por exemplo, você pode querer mudar o nome ou o e-mail de um usuário em um banco de dados. Neste post do blog, eu vou mostrar como fazer uma requisição put em Node.js usando diferentes métodos e ferramentas como Apidog.
No final deste post do blog, você será capaz de fazer uma requisição put em Node.js com confiança e facilidade. Vamos começar!
O que é uma Requisição Put e Quando Usá-la
Uma requisição put é uma das quatro requisições HTTP comuns, junto com get, post e delete. Uma requisição put é usada para atualizar ou substituir um recurso existente em um servidor. Por exemplo, se você tem um usuário com o id de 1 e o nome de Alice, e você quer mudar o nome dela para Bob, você pode fazer uma requisição put para o servidor com o novo nome.
Uma requisição put tem dois componentes principais: uma URL e um corpo. A URL é o endereço do recurso que você deseja atualizar, e o corpo são os dados que você deseja enviar ao servidor. Por exemplo, se você quiser atualizar o usuário com o id de 1, sua URL pode ser assim:
https://example.com/api/users/1
E seu corpo pode ser assim:
{ "name": "Bob" }
O corpo pode estar em diferentes formatos, como JSON, XML ou dados de formulário. Neste post do blog, usaremos JSON como o formato do corpo.
Para fazer uma requisição put, você precisa especificar o método, a URL e o corpo em seu código. Você também precisa definir alguns cabeçalhos, como o content-type e a autorização. O cabeçalho content-type informa ao servidor em qual formato o corpo está, e o cabeçalho de autorização fornece suas credenciais para acessar o recurso. Por exemplo, se você estiver usando JSON como o formato do corpo e precisar de um token para acessar o recurso, seus cabeçalhos podem ser assim:
{ "Content-Type": "application/json", "Authorization": "Bearer <seu-token>" }
Nas próximas seções, veremos como fazer uma requisição put em Node.js usando diferentes métodos e bibliotecas.
Entender o NodeJs
Node.js é um ambiente de execução JavaScript que permite executar código JavaScript fora de um navegador web. O Node.js é baseado no motor JavaScript V8 do Google Chrome, e é usado para construir aplicações web, especialmente aquelas que são intensivas em dados e em tempo real. O Node.js também possui uma vasta biblioteca de módulos e pacotes que você pode usar para adicionar funcionalidades aos seus projetos. Alguns dos benefícios do Node.js são:
- É rápido e escalável, graças à sua natureza assíncrona e orientada a eventos.
- É multiplataforma e open-source, o que significa que você pode executá-lo em vários sistemas operacionais e contribuir para seu desenvolvimento.
- É consistente e unificado, pois você pode usar a mesma linguagem tanto para o front-end quanto para o back-end de sua aplicação web.
Como Fazer uma Requisição Put Usando o Módulo Http Nativo
Uma maneira de fazer uma requisição put em Node.js é usar o módulo http nativo. O módulo http é um módulo central que fornece funcionalidades de baixo nível para fazer requisições e respostas HTTP. Para usar o módulo http, você precisa importá-lo em seu código:
const http = require('http');
Para fazer uma requisição put usando o módulo http, você precisa usar o método http.request(). O método http.request() aceita dois argumentos: um objeto de opções e uma função de callback. O objeto de opções contém os detalhes da requisição, como o método, a URL, os cabeçalhos e o corpo. A função de callback é executada quando a requisição é concluída, e recebe um objeto de resposta como argumento. O objeto de resposta contém o código de status, os cabeçalhos e os dados do servidor.
Por exemplo, se você quiser fazer uma requisição put para atualizar o usuário com o id de 1, seu código pode ser assim:
const http = require('http');
// Defina o objeto de opções
const options = {
method: 'PUT',
hostname: 'example.com',
path: '/api/users/1',
headers: {
'Content-Type': 'application/json',
'Authorization': 'Bearer <seu-token>'
}
};
// Defina o corpo
const body = JSON.stringify({ name: 'Bob' });
// Crie a requisição
const req = http.request(options, (res) => {
// Manipule a resposta
console.log(`Código de status: ${res.statusCode}`);
console.log(`Cabeçalhos: ${JSON.stringify(res.headers)}`);
let data = '';
res.on('data', (chunk) => {
// Concatene os chunks de dados
data += chunk;
});
res.on('end', () => {
// Analise os dados como JSON
data = JSON.parse(data);
console.log(`Dados: ${JSON.stringify(data)}`);
});
});
// Manipule o erro
req.on('error', (err) => {
console.error(`Erro: ${err.message}`);
});
// Escreva o corpo na requisição
req.write(body);
// Termine a requisição
req.end();
O método http.request() retorna um objeto de requisição, que você pode usar para escrever o corpo na requisição e encerrar a requisição. Você também pode usar o objeto de requisição para manipular quaisquer erros que possam ocorrer durante a requisição.
O objeto de resposta é uma instância da classe http.IncomingMessage, que é um stream legível. Isso significa que você pode usar o método on() para escutar diferentes eventos, como dados e fim. O evento de dados é emitido quando um chunk de dados é recebido, e o evento de fim é emitido quando a resposta é finalizada. Você pode usar esses eventos para concatenar os chunks de dados e analisá-los como JSON.
O objeto de resposta também possui algumas propriedades, como statusCode e headers, que você pode usar para obter o código de status e os cabeçalhos do servidor.
Como Fazer uma Requisição Put Usando a Biblioteca Request Popular
Outra maneira de fazer uma requisição put em Node.js é usar a popular biblioteca request. A biblioteca request é um módulo de terceiros que fornece uma maneira simples e conveniente de fazer requisições HTTP. Para usar a biblioteca request, você precisa instalá-la usando o npm:
npm install request
E então importá-la em seu código:
const request = require('request');
Para fazer uma requisição put usando a biblioteca request, você precisa usar o método request.put(). O método request.put() aceita dois argumentos: uma URL e uma função de callback. A URL pode ser uma string ou um objeto que contém os detalhes da requisição, como o método, os cabeçalhos e o corpo. A função de callback é executada quando a requisição é concluída, e recebe três argumentos: um erro, uma resposta e um corpo. O argumento de erro é nulo se a requisição for bem-sucedida, e contém um objeto de erro se a requisição falhar. O argumento de resposta é um objeto que contém o código de status, os cabeçalhos e os dados do servidor. O argumento do corpo é uma string ou um buffer que contém os dados do servidor.
Como Lidar com Erros e Respostas do Servidor
Quando você faz uma requisição put em Node.js, precisa estar preparado para lidar com quaisquer erros e respostas que possam vir do servidor. Erros podem ocorrer por diversas razões, como problemas de rede, problemas no servidor ou dados inválidos. As respostas podem variar dependendo do código de status, dos cabeçalhos e dos dados do servidor.
Para lidar com erros, você precisa usar o argumento de erro ou o método catch(), dependendo do método ou biblioteca que você está usando. O argumento de erro ou o método catch() receberão um objeto de erro, que você pode usar para obter a mensagem, o código e as informações da requisição. Você também pode usar o método console.error() para registrar o erro no console.
Para lidar com respostas, você precisa usar o argumento de resposta ou o método then(), dependendo do método ou biblioteca que você está usando. O argumento de resposta ou o método then() receberão um objeto de resposta, que você pode usar para obter o código de status, os cabeçalhos e os dados do servidor. Você também pode usar o método console.log() para registrar a resposta no console.
O código de status é um número de três dígitos que indica o resultado da requisição. O código de status pode ser dividido em cinco categorias:
- 1xx: Respostas informativas
- 2xx: Respostas bem-sucedidas
- 3xx: Respostas de redirecionamento
- 4xx: Respostas de erro do cliente
- 5xx: Respostas de erro do servidor
O código de status mais comum para uma requisição put é 200, que significa OK. Isso significa que a requisição foi bem-sucedida e o recurso foi atualizado. No entanto, dependendo da implementação do servidor, você também pode receber outros códigos de status, como 201, que significa Criado, ou 204, que significa Sem Conteúdo. Você deve sempre verificar o código de status antes de processar os dados da resposta.
Os cabeçalhos são um conjunto de pares chave-valor que fornecem informações adicionais sobre a requisição e a resposta. Os cabeçalhos podem conter informações como content-type, content-length, data, servidor e autorização. Você deve sempre verificar os cabeçalhos antes de processar os dados da resposta, pois eles podem afetar como você analisa ou exibe os dados.
Os dados são o conteúdo real da resposta, que pode estar em diferentes formatos, como JSON, XML ou texto simples. Os dados podem conter informações como o recurso atualizado, a mensagem ou o erro. Você deve sempre analisar os dados de acordo com o formato especificado pelo cabeçalho content-type e lidar com quaisquer erros ou mensagens que possam estar incluídas nos dados.
Como Testar Sua Requisição Put Usando uma Ferramenta Chamada Apidog
Uma maneira de testar sua requisição put em Node.js é usar uma ferramenta chamada Apidog. Apidog é uma ferramenta baseada na web que permite criar e testar APIs de maneira simples e interativa. Você pode usar Apidog para criar servidores mock, definir endpoints, enviar requisições e visualizar respostas. Você também pode usar Apidog para gerar documentação e trechos de código para suas APIs.
Aqui está como você pode usar Apidog para testar sua requisição PUT:
- Abra o Apidog e crie uma nova requisição.
2. Defina o método da requisição como PUT.
3. Digite a URL do recurso que você deseja atualizar. Adicione quaisquer cabeçalhos ou parâmetros adicionais que você queira incluir e então clique no botão “Enviar” para enviar a requisição.
4. Verifique se a resposta é o que você esperava.
Conclusão
Neste post do blog, você aprendeu como fazer uma requisição put em Node.js usando diferentes métodos e bibliotecas. Você também aprendeu como lidar com erros e respostas do servidor, e como testar sua requisição put usando uma ferramenta chamada Apidog. Você pode usar essas habilidades para atualizar ou modificar qualquer recurso em um servidor usando Node.js.
