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. Abaixo, estão listados os principais endpoints que serão utilizados.

Abaixo está o swagger relativo à API. Este pode ser visualizado no link: Editor Swagger

kobe-swagger.yml

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:

Nesse exemplo, o Restapify nos retorna o mock de features na URL http://localhost:6767/api/documents/feature