Issue-236 - Creation of mock API for the frontend #254
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 |
Alecell
suggested changes
Jun 3, 2024
DominMFD
approved these changes
Jun 5, 2024
Alecell
approved these changes
Jun 5, 2024
JonasGz
pushed a commit
to JonasGz/pet-dex-frontend-p4n4
that referenced
this pull request
Jun 15, 2024
* feat: create frontend mock api * style: adding EOF that was missing * style: adjusting EOF * style: adjusting prettier error
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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/idAPI 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/idVisual 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/petsEsse 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.