Skip to content
This repository has been archived by the owner on May 18, 2024. It is now read-only.
Davidson Bruno edited this page Oct 17, 2019 · 4 revisions

Especificação

Usuários

Acesso Verbo Rota Descrição
Público GET /users Lista todos os usuários.
Privado POST /users Adiciona um novo usuário.
Público GET /@{username} Lista o usuário especificado.
Privado PUT /@{username} Atualiza o usuário especificado.
Privado DELETE /@{username} Apaga o usuário especificado.
Público GET /@{username}/animals Lista os animais do usuário especificado.
Privado GET /@{username}/orders Lista as ordens de serviço do usuário especificado.
Privado GET /@{username}/orders/accepted Lista as ordens de serviço do usuário

Animais

Acesso Verbo Rota Descrição
Público GET /animals Lista todos os animais.
Privado POST /animals Adiciona um novo animal.
Público GET /+{animal} Lista o animal especificado.
Privado PUT /+{animal} Atualiza o animal especificado.
Privado DELETE /+{animal} Apaga o animal especificado.
Público GET /+{animal}/owners Lista os donos do animal especificado.
Privado GET /+{animal}/orders Lista as ordens de serviço do animal especificado.

Raças de animal

Acesso Verbo Rota Descrição
Público GET /animals/bleeds Lista todas as raças de animais.
Privado POST /animals/bleeds Adiciona uma nova raça de animal.
Público GET /animals/bleeds/{id} Lista a raça de animal especificada.
Privado PUT /animals/bleeds/{id} Atualiza a raça de animal especificada.
Privado DELETE /animals/bleeds/{id} Apaga a raça de animal especificada.

Tipos de animal

Acesso Verbo Rota Descrição
Público GET /animals/types Lista todos os tipos de animais.
Privado POST /animals/types Adiciona um novo tipo de animal.
Público GET /animals/types/{id} Lista o tipo de animal especificado.
Privado PUT /animals/types/{id} Atualiza o tipo de animal especificado.
Privado DELETE /animals/types/{id} Apaga o tipo de animal especificado.

Serviços

Acesso Verbo Rota Descrição
Público GET /services Lista todos os serviços prestados.
Privado POST /services Adiciona um novo serviço.
Público GET /services/{id} Lista o serviço especificado.
Privado PUT /services/{id} Atualiza o serviço especificado.
Privado DELETE /services/{id} Apaga o serviço especificado.

Ordens de serviço

Acesso Verbo Rota Descrição
Privado GET /orders Lista todas as ordens de serviço.
Privado GET /orders/accepted Lista todas as ordens de serviço aceitas.
Privado POST /orders Adiciona uma nova ordem de serviço.
Privado GET /orders/{id} Lista a ordem de serviço especificada.
Privado PUT /orders/{id} Atualiza a ordem de serviço especificada.
Privado DELETE /orders/{id} Apaga a ordem de serviço especificada.

Status

Acesso Verbo Rota Descrição
Privado GET /status Lista todos os registros de status.
Privado POST /status Adiciona um novo registro de status.
Privado GET /status/{id} Lista o registro de status especificado.
Privado PUT /status/{id} Atualiza o registro de status especificado.
Privado DELETE /status/{id} Apaga registro de status especificado.

Exemplos

https://mypets.com/api/@davidsonbrsilva
https://mypets.com/api/@davidsonbrsilva/animals
https://mypets.com/api/@davidsonbrsilva/orders

https://mypets.com/api/+kadu/
https://mypets.com/api/+kadu/owners
https://mypets.com/api/+kadu/orders

https://mypets.com/api/users
https://mypets.com/api/animals
https://mypets.com/api/animals/bleeds
https://mypets.com/api/animals/bleeds/1
https://mypets.com/api/animals/types
https://mypets.com/api/animals/types/1
https://mypets.com/api/orders
https://mypets.com/api/orders/1