Neste post rápido vou falar um pouco sobre os tipos de parâmetros usados nas requisições em API’s REST e exemplos simples de uso.
O que são parâmetros de API?
Os parâmetros da API são as partes variáveis de um recurso (rota). Eles determinam o tipo de ação que você deseja executar no recurso. Cada parâmetro tem um nome e tipo de valor. Sempre que quiser construir uma API REST , você deve decidir quais parâmetros devem estar presentes nos endpoints da sua API . Em termos simples, os parâmetros da API são opções que podem ser passadas com o terminal para influenciar a resposta.
Tipos de parâmetros da API REST
Existem quatro tipos diferentes de parâmetros que geralmente são documentados e utilizados na prática em uma API REST. São eles:
Header Parameters – Ex.: sessionId: 258dsf5ad8d
Query Parameters – Ex.: /users?role=admin
Path Parameters – Ex.: /users/id
Body Parameters – Ex.: “name”: “Josias”, “email”: “josias@mail.com”
Header Parameters
Esses parâmetros são apresentados no cabeçalho da solicitação e geralmente estão relacionados à autorização, como tokens, controle de sessão e dados de cookies. Esse tipo de parâmetro aparece em qualquer método HTTP (GET, POST, PUT, DELETE).
authority: josiaspereira.com.br
method: GET
path: /o-que-e-rest-um-resumo-rapido/
scheme: https
referer: https://josiaspereira.com.br/
Query Parameters
Os parâmetros de consulta são o tipo de parâmetro mais comum. Eles aparecem no final do URL de solicitação após um ponto de interrogação ( ?), com name=value. Cada parâmetro desse tipo é separado por e comercial ( &). Os parâmetros de consulta podem ser obrigatórios e opcionais.
Além disso, eles não são únicos, no sentido de que podem ser usados para especificar qualquer parâmetro várias vezes.
http://myapi/pets/findByStatus?status=available
http://myapi/notes?offset=100&limit=50
Path Parameters
Os parâmetros de caminho são partes variáveis de um caminho de URL. Eles geralmente são usados para apontar para um recurso específico dentro de uma coleção, como um usuário identificado por ID. Um URL pode ter vários parâmetros de caminho, cada um denotado por chaves .
//http://myapi/users/id
//http://myapi/cars/carId/drivers/driverId
http://myapi/users/584
http://myapi/cars/25/drivers/9
Body Parameters
Eles estão incluídos no corpo da solicitação e são usados para enviar e receber dados por meio da API REST. Há quem diga que esse tipo não é um parâmetro, mas decidi colocá-lo nesta lista pois é muito utilizado nas requisições PUT, e POST.
“name”:”Josias”, “age”:26, “car”:null
Concluindo
Neste post vimos como cada tipo de parâmetro utilizado em requisições à API’s REST funcionam e como utilizar cada um deles. Embora paressa simples, é muito importante ter esses conceitos em mete na hora de criar sua API.
Ficou com dúvida? sinta-se a vontate para me escrever nos comentários!
LEIA TAMBÉM: