mockonlinemockonlineBetaDocumentação
Abrir app
Docs/Endpoints/Query params & body

Query params & body

Documente os parâmetros que seu endpoint aceita: na URL (query params) e no corpo da requisição (body).

Query params

Parâmetros aceitos na URL no formato ?key=value.

curl
curl "https://api.mockonline.com.br/v1/mock/{username}/api/products?page=2&limit=10"
ParâmetroExemploDescrição
page2Página dos resultados.
limit10Itens por página.
sortpriceCampo de ordenação.

Os query params são documentais: o mock devolve sempre o mesmo body configurado, independente dos valores.

Body da requisição

Parâmetros enviados no corpo — disponível para POSTe PUT e PATCH.

POST/v1/mock/{username}/api/cart
curl
curl -X POST https://api.mockonline.com.br/v1/mock/{username}/api/cart \
  -H "Content-Type: application/json" \
  -d '{ "productId": 1, "quantity": 2 }'

Variáveis de rota

Diferente dos query params, variáveis de rota fazem parte do path. Declare com :param.

GET/v1/mock/{username}/api/products/:id

Qualquer valor casa com :id — /api/products/1, /api/products/999 etc.