No protocolo HTTP, a requisição PATCH é utilizada para atualizar parcialmente um recurso existente. Ela difere da requisição PUT, que substitui o recurso completo por um novo estado.
Cenários de uso:
- Atualizar campos específicos em um registro de banco de dados.
- Modificar uma parte de um arquivo de configuração.
- Aplicar um conjunto de alterações em um documento JSON.
Estrutura da requisição:
PATCH /recurso URL HTTP/1.1
Authorization: Bearer
Content-Type: application/json
[…]
{
“campo1”: “valor_atualizado”,
“campo2”: {
“subcampo”: “novo_valor”
},
…
}
Exemplo:
Considere um registro de cliente com os seguintes campos:
- id: 123
- nome: “João Silva”
- email: “[endereço de email removido]”
Para atualizar o nome do cliente para “Maria Oliveira”, a seguinte requisição PATCH seria utilizada:
PATCH /clientes/123 HTTP/1.1
Authorization: Bearer
Content-Type: application/json
{
“nome”: “Maria Oliveira”
}
Resposta:
A resposta da requisição PATCH segue o mesmo formato das demais requisições HTTP, com os códigos de status informando o sucesso ou falha da operação. Em caso de sucesso, o corpo da resposta pode conter o recurso atualizado.
Considerações:
- A requisição PATCH deve ser utilizada apenas quando se deseja atualizar campos específicos de um recurso.
- É importante verificar a documentação da API para entender quais campos podem ser atualizados através da requisição PATCH.
- A requisição PATCH é idempotente, o que significa que sua execução repetida com o mesmo conteúdo terá o mesmo efeito.
Espero que esta explicação tenha sido útil! Se tiver mais dúvidas, por favor, me avise.