-
Notifications
You must be signed in to change notification settings - Fork 44
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Issue-236 - Creation of mock API for the frontend #254
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ta faltando a Api de Pets
A API de Pets ficou incluída dentro da API de Users. Eu tinha feito separado, mas o Alê recomendou que ela ficasse dentro mesmo. E a API de pets tem um erro por falta de suporte pra rotas customizadas no json-server. O Alê disse que depois vai ser criada uma nova issue só pra resolver esse problema |
* feat: create frontend mock api * style: adding EOF that was missing * style: adjusting EOF * style: adjusting prettier error
Closes #236
Feature
Criação de mock da API para simular a comunicação dos componentes com os serviços do frontend, enquanto a API do backend não está pronta para uso.
Changelog
O mock da API foi criado utilizando Json-Server que é uma biblioteca Node.JS usada para simular API REST a partir de um arquivo JSON. E para realizar os testes dos endpoints da API foi utilizado o Postman.
Esse mock utiliza os métodos GET, POST, PUT, DELETE do protocolo HTTP para realizar as requisições das informações. Abaixo estão documentados os endpoints necessários para cada requisição:
API do Usuário
[GET] Pega todos os usuários
URL:
/users/
[GET] Pega usuário específico pelo ID
URL:
/users/id
[POST] Adiciona novo usuário
URL:
/users/
[PUT] Atualiza um usuário pelo ID
URL:
/users/id
[DELETE] Deleta um usuário específico pelo ID
URL:
/users/id
API de raças
[GET] Pega todas as raças
URL:
/breed/
[GET] Pega raça específica pelo ID
URL:
/breed/id
[POST] Adiciona uma nova raça
URL:
/breed/
[PUT] Atualiza uma raça pelo ID
URL:
/breed/id
[DELETE] Deleta uma raça específica pelo ID
URL:
/breed/id
Visual evidences 🖼️
Arquivo JSON do mock da API:
Checklist
Additional info
[ ! ] É importante destacar, que qualquer adição ou alteração feita para testar componentes no frontend, deve seguir o padrão estabelecido no JSON para manter o padrão que será utilizado posteriormente pela API do backend.
[OBS] O mock da API apresenta um erro interno de rota que impossibilita fazer requisição para a API de Pets do usuário e retorna Error 404.
Ex:
URL:
/users/id/pets
Esse problema provavelmente se deve ao fato da biblioteca usada não fornecer suporte para essa rota customizada e será criada uma nova issue para corrigir esse problema utilizando outros meios em breve.