API - Guia de Estilo

Métodos HTTP

205 views 05/08/2020 23/11/2020 jefersonfrancisco 1

As entidades disponibilizadas na plataforma seguem o padrão REST. Abaixo uma tabela com os métodos utilizados:

Verbo Responsabilidade Exemplo
GET Obtém uma coleção de itens de uma entidade (recurso) GET /task
GET Obtém uma entidade pela identificação única GET /task/(id)
POST Insere um recurso informando todos os campos da entidade e entidades relacionadas. Nesta operação, é necessário informar todos os campos, inclusive das entidades relacionadas. POST /task
PATCH Atualiza um recurso podendo ser alterado apenas os campos enviados na requisição, deferente do PUT que altera o recurso inteiro. PATCH /task
PUT Atualiza um recurso informando todos os campos PUT /task/(id)
DELETE Exclui um recurso DELETE /task/(id)

Em muitos cenários é necessário criar comportamentos específicos para atender a regra de negócio que as APIs disponibilizadas pelas entidades não resolvem. Como por exemplo remover um registro validando uma série de regras; enviar uma notificação, etc. Ou até mesmo realizar buscas mais complexas validando informações em outros serviços. Pensando nestes cenários temos alguns serviços conhecidos como primitivas que são distinguidos na URL conforme visto na sessão Estrutura de URL.

Actions – Utiliza o método POST, é usado quando o serviço deve realizar uma ação que altera um estado e devolve uma resposta (ex: alterar um status, remover um registro).

Queries –  Utiliza os métodos GET/POST para ser usado em dados mais estruturados e complexos. Utilizado quando o serviço deve devolver uma informação, mas seu estado não se altera. (ex: Buscar um grupo.)

Signals – Utiliza o método POST, envia uma requisição para o servidor que fará o processamento de forma assíncrona. O requisitante não aguarda o resultado do processamento. (ex: Alterar o tipo de autenticação de todos os usuários).

Este artigo foi útil para você?