Como fazer uma solicitação PUT em Python (Guia de 2024)

Neste post do blog, vamos explorar os fundamentos das solicitações PUT, como realizá-las usando Python Requests e algumas melhores práticas a serem lembradas. Seja você um desenvolvedor experiente ou alguém que está começando, este guia fornecerá tudo o que você precisa saber sobre solicitações PUT.

Fundamentos das Solicitações HTTP

Antes de mergulharmos na solicitação PUT, vamos primeiro entender o que é uma solicitação HTTP. HTTP significa Protocolo de Transferência de Hipertexto, que é um protocolo usado para transferir dados pela internet. Uma solicitação HTTP é uma mensagem enviada por um cliente a um servidor, solicitando um recurso específico. O servidor, então, responde com o recurso solicitado.

Existem vários métodos HTTP, também chamados de solicitações HTTP, cada um servindo a um propósito distinto e transmitindo a natureza da solicitação. Os métodos HTTP mais comuns incluem GET, POST, PUT e DELETE.

O que é uma solicitação PUT?

Uma solicitação PUT é um método HTTP usado para atualizar ou substituir um recurso existente em um servidor. É semelhante ao método POST, mas em vez de criar um novo recurso, atualiza um existente. As solicitações PUT são idempotentes, o que significa que várias solicitações terão o mesmo resultado.

Em termos simples, uma solicitação PUT é usada para atualizar um recurso no servidor. Ela envia dados para o servidor para serem armazenados em um recurso ou URL especificado. Pense nisso como o comando que diz ao servidor: "Ei, eu tenho algumas novas informações para você; substitua as antigas por estas!"

O que é Python?

Agora que cobrimos os fundamentos das solicitações HTTP, vamos falar sobre a linguagem de programação que será nossa fiel companheira nesta jornada – Python. Python é renomado por sua simplicidade, legibilidade e versatilidade. É uma linguagem de alto nível que permite aos desenvolvedores escrever códigos claros e lógicos para projetos de todos os tamanhos. A versão mais recente do Python pode ser obtida visitando o site oficial e fazendo o download a partir daí.

As bibliotecas extensas do Python fazem dele um favorito entre os desenvolvedores, e sua sintaxe assegura que até mesmo os iniciantes possam entender seus conceitos rapidamente. Então, por que não aproveitar o poder do Python para tornar nossas solicitações PUT mais suaves do que nunca?

Como fazer uma solicitação PUT usando Python

Para fazer uma solicitação PUT usando Python, você precisará usar a biblioteca requests. Essa biblioteca permite que você envie solicitações HTTP/1.1 de forma extremamente fácil.

No Python, você pode fazer uma solicitação PUT usando a biblioteca requests, que é uma popular biblioteca HTTP para fazer solicitações HTTP. Se você não a tem instalada, pode instalá-la usando:

pip install requests

Aqui está um exemplo de como fazer uma solicitação PUT usando a biblioteca requests:

import requests

url = "https://example.com/api/resource"
data = {"key1": "value1", "key2": "value2"}

headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer your_access_token"  # Incluir quaisquer cabeçalhos necessários
}

response = requests.put(url, json=data, headers=headers)

# Verifique a resposta
if response.status_code == 200:
    print("Solicitação PUT bem-sucedida")
    print("Resposta:", response.json())
else:
    print("Falha na solicitação PUT")
    print("Código de status:", response.status_code)
    print("Resposta:", response.text)

Neste exemplo:

• url é o endpoint para o qual você deseja enviar a solicitação PUT.
• data é os dados que você deseja enviar no corpo da solicitação. Você pode alterá-lo com base nas necessidades da sua API.
• headers é um dicionário que contém quaisquer cabeçalhos adicionais que você precisa incluir, como cabeçalhos de autenticação.
• response contém a resposta do servidor à solicitação PUT.

Certifique-se de substituir a URL, os dados e os cabeçalhos pelos seus valores reais. Ajuste o tipo de conteúdo e os cabeçalhos de autenticação de acordo com as especificações da sua API.

Nota: Este exemplo assume que você está trabalhando com dados JSON. Se a sua API exigir um tipo de conteúdo ou formato de dados diferente, pode ser necessário modificar o código de acordo.

Aqui estão exemplos de diferentes tipos de conteúdo e formatos de dados:

Exemplo 1: Enviando Dados de Formulário

import requests

url = "https://example.com/api/resource"
data = {"key1": "value1", "key2": "value2"}

headers = {
    "Content-Type": "application/x-www-form-urlencoded",
    "Authorization": "Bearer your_access_token"
}

response = requests.put(url, data=data, headers=headers)

if response.status_code == 200:
    print("Solicitação PUT bem-sucedida")
    print("Resposta:", response.text)
else:
    print("Falha na solicitação PUT")
    print("Código de status:", response.status_code)
    print("Resposta:", response.text)

Exemplo 2: Enviando Dados XML

import requests

url = "https://example.com/api/resource"
data = """
<root>
    <key1>value1</key1>
    <key2>value2</key2>
</root>
"""

headers = {
    "Content-Type": "application/xml",
    "Authorization": "Bearer your_access_token"
}

response = requests.put(url, data=data, headers=headers)

if response.status_code == 200:
    print("Solicitação PUT bem-sucedida")
    print("Resposta:", response.text)
else:
    print("Falha na solicitação PUT")
    print("Código de status:", response.status_code)
    print("Resposta:", response.text)

Exemplo 3: Enviando Texto Simples

import requests

url = "https://example.com/api/resource"
data = "Este é um dado de texto simples."

headers = {
    "Content-Type": "text/plain",
    "Authorization": "Bearer your_access_token"
}

response = requests.put(url, data=data, headers=headers)

if response.status_code == 200:
    print("Solicitação PUT bem-sucedida")
    print("Resposta:", response.text)
else:
    print("Falha na solicitação PUT")
    print("Código de status:", response.status_code)
    print("Resposta:", response.text)

ajuste o Content-Type e o formato do parâmetro data de acordo com os requisitos da sua API. Sempre consulte a documentação da API para garantir que você está usando o tipo de conteúdo e o formato de dados corretos.

Entendendo os parâmetros da solicitação PUT em Python.

Ao fazer uma solicitação PUT, existem vários parâmetros que você pode usar para personalizar sua solicitação. Aqui estão alguns dos parâmetros mais comuns:

• URL: A URL do recurso que você deseja atualizar.
• Dados: Os dados que você deseja enviar na solicitação PUT. Você pode usar o parâmetro json para enviar dados JSON ou o parâmetro data para enviar dados codificados em formulário.
• Cabeçalhos: Os cabeçalhos que você deseja incluir na solicitação PUT. Você pode usar o parâmetro headers para especificar cabeçalhos como Content-Type, Authorization, etc.
• Autenticação: Se o endpoint exigir autenticação, você pode usar o parâmetro auth para fornecer credenciais de autenticação.
• Tempo limite: Você pode definir um tempo limite para a solicitação usando o parâmetro timeout. Isso especifica o número de segundos para esperar por uma resposta antes de expirar.
• Proxies: Se você precisar usar um proxy para fazer a solicitação, pode usar o parâmetro proxies para especificar a URL do proxy.
• Verificar: Se você deseja verificar o certificado SSL do servidor, pode definir o parâmetro verify como True. Se você quiser desativar a verificação do certificado, pode defini-lo como False.
• Permitir redirecionamentos: Por padrão, requests seguirá automaticamente os redirecionamentos. Se você deseja desabilitar esse comportamento, pode definir o parâmetro allow_redirects como False.

Aqui está um exemplo de como usar o parâmetro data para enviar uma solicitação PUT:

import requests

url = 'https://api.example.com/resource'
payload = {'key1': 'value1', 'key2': 'value2'}

r = requests.put(url, data=payload)

Neste exemplo, estamos enviando uma solicitação PUT para https://api.example.com/resource com um payload de {'key1': 'value1', 'key2': 'value2'}.

Usando Apidog para Testar sua Solicitação PUT em Python

Apidog é uma ferramenta poderosa para testar APIs. Ela permite que você crie e salve solicitações de API, as organize em coleções e as compartilhe com sua equipe.

Aqui está como você pode usar o Apidog para testar sua solicitação PUT:

1. Abra o Apidog e crie uma nova solicitação.

2. Defina o método da solicitação como PUT.

3. Digite a URL do recurso que deseja atualizar. Adicione quaisquer cabeçalhos ou parâmetros adicionais que deseja incluir, em seguida clique no botão “Enviar” para enviar a solicitação.

4. Verifique se a resposta é o que você esperava.

Melhores práticas para fazer uma solicitação PUT.

Ao fazer uma solicitação PUT, é importante lidar adequadamente com erros. Você deve sempre verificar o código de status da resposta para garantir que a solicitação foi bem-sucedida. Você também deve tratar quaisquer erros que possam ocorrer durante a solicitação.

Aqui estão algumas melhores práticas para fazer uma solicitação PUT em Python:

1. Tratamento de erros: Sempre inclua um tratamento de erros apropriado no seu código para garantir que seu programa não falhe quando um erro ocorrer. Você pode usar as instruções try e except para tratar erros em Python. Por exemplo, você pode capturar todas as exceções usando a exceção de classe base Exception ou capturá-las separadamente e fazer coisas diferentes.
2. Autenticação: Alguns endpoints exigem autenticação usando cabeçalhos, tokens ou credenciais do usuário. Certifique-se de que sua solicitação inclua esses dados quando necessário. Você pode usar o parâmetro auth na biblioteca requests para fornecer credenciais de autenticação. Por exemplo, você pode usar autenticação básica com a classe HTTPBasicAuth fornecida pela biblioteca requests. Se você estiver acessando uma URL que exige autenticação do Windows, pode usar a biblioteca Requests-NTLM.
3. Segurança: Ao fazer uma solicitação PUT, assegure-se de que os dados sejam enviados de forma segura. Se você estiver enviando dados via HTTP, é recomendável usar HTTPS em vez disso. Você pode verificar se seu certificado é bom executando openssl s_client -showcerts -connect example.com:443 a partir da linha de comando e verificando se ele relata Código de retorno da verificação: 0 (ok). Você também pode desativar a verificação do certificado de segurança nas solicitações Python usando um gerenciador de contexto que altera as solicitações e faz com que verify=False seja o padrão e suprime o aviso.

Conclusão

Neste post do blog, exploramos o que é uma solicitação PUT, como fazer uma solicitação PUT usando Python e como testar sua solicitação PUT usando Apidog. Também discutimos os vários parâmetros que você pode usar para personalizar sua solicitação PUT. Com esse conhecimento, você deve ser capaz de usar solicitações PUT com confiança em seus próprios projetos de desenvolvimento web.