DEV Community

Determinado 96
Determinado 96

Posted on

Um resumo sobre tipos de Parâmetros em REST

Tipos de parâmetros

Em APIs REST existem 3 tipos principais de parâmetros:

Tipo Onde fica Para que serve
Path Param URL Identificar recurso
Query Param URL Filtrar / paginar / ordenar
Body Corpo da requisição Enviar dados

Path Parameter (req.params)

Parâmetro que vai na URL e serve para identificar um recurso específico (usuário, linha na tabela com base num id).

Exemplo:

GET /chamados/6
PUT /chamados/6
DELETE /chamados/6

Pode ter mais que um?

Sim, um por segmento da URL.

GET /usuarios/10/chamados/6

Quando usar?

Situação Exemplo
Buscar 1 registro /chamados/6
Atualizar /chamados/6
Deletar /chamados/6
Recurso relacionado /usuarios/10/chamados/6

Query Parameter (req.query)

Parâmetro que vai depois do ? na URL e serve para filtrar ou consultar dados.

Exemplo:

GET /chamados?status=aberto
GET /chamados?prioridade=alta
GET /chamados?page=2&limit=10
GET /chamados?status=aberto&prioridade=alta

Quando usar?

Situação Exemplo
Filtro ?status=aberto
Paginação ?page=2
Limite ?limit=10
Ordenação ?order=prioridade
Busca ?search=mouse

Body Parameter (req.body)

Dados enviados no corpo da requisição (normalmente JSON).

Usado em:

Método Uso
POST Criar
PUT Atualizar
PATCH Atualizar parcial

Body Json

{
"titulo": "Mouse quebrado",
"descricao": "Meu mouse parou de funcionar",
"prioridade": "ALTA"
}

Body também vem de FORMS

Quando você envia um form HTML, os dados também vão no body, não na query.

Top comments (0)