|
|
|
<table>
|
|
|
|
<tr>
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[Home](home)
|
|
|
|
</th>
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[Sprints](sprints)
|
|
|
|
</th>
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[Requisitos](requisitos)
|
|
|
|
</th>
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[Arquitetura](arquitetura)
|
|
|
|
</th>
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[Configuração](configuracao)
|
|
|
|
</th>
|
|
|
|
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[Desenvolvimento](desenvolvimento)
|
|
|
|
</th>
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[Mockups](mockups)
|
|
|
|
</th>
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[Banco de Dados](banco_dados)
|
|
|
|
</th>
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[Instalação](instalacao)
|
|
|
|
</th>
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[Gerência de Projeto](Gerenciamento%20do%20Projeto)
|
|
|
|
</th>
|
|
|
|
<th>
|
|
|
|
|
|
|
|
[Horários Disponiveis](horarios)
|
|
|
|
</th>
|
|
|
|
</tr>
|
|
|
|
</table>
|
|
|
|
|
|
|
|
## Descrição
|
|
|
|
|
|
|
|
Aqui serão apresentadas as convenções de desenvolvimento. Padrões, documentação e conceitos básicos serão abordados.
|
|
|
|
|
|
|
|
### Guidelines de chamadas para o Firebase
|
|
|
|
|
|
|
|
Para consumir os dados do Firebase, vamos utilizar a Firestore API, e para o environment de desenvolvimento, vamos usar a [Restapify](https://restapify.vercel.app/). Abaixo, estão listados os principais endpoints que serão utilizados.
|
|
|
|
|
|
|
|
#### `GET /documents/{collection}`
|
|
|
|
|
|
|
|
Faz o fetch de todos os itens de uma coleção no Firestore.
|
|
|
|
|
|
|
|
##### Exemplo: `/documents/feature`
|
|
|
|
|
|
|
|
#### `GET /documents/{collection}/{id}`
|
|
|
|
|
|
|
|
Faz o fetch de um item específico de uma coleção no Firestore.
|
|
|
|
|
|
|
|
##### Exemplo: `/documents/feature/U9JnchPOqvWaC0sfNQ9I`
|
|
|
|
|
|
|
|
Após criar uma chamada, é importante fazermos a criação de mocks, que devem retornar dados na mesma estrutura da nossa API real. O uso de mocks é muito importante no projeto para evitar o sobrecarregamento do nosso free tier no Firebase. Os mocks devem ser criados seguindo a estrutura abaixo para serem reconhecidos pelo Restapify:
|
|
|
|
|
|
|
|
![Screenshot_2023-04-09_at_17.28.15](uploads/70b6ab0535f2baaf989ccfa770f68a10/Screenshot_2023-04-09_at_17.28.15.png)
|
|
|
|
|
|
|
|
Nesse exemplo, o Restapify nos retorna o mock de features na URL `http://localhost:6767/api/documents/feature` |
|
|
|
\ No newline at end of file |