Descrição

Aqui serão apresentadas as convenções de desenvolvimento. Padrões, documentação e conceitos básicos serão abordados.

Padronização de IDs nos componentes

Para que seja possível realizar os testes endToEnd no frontend, adotamos a seguinte padronização dos IDs nos componentes das páginas:

nomeabbrpagina-nomeabbrcomponente-identificador

Onde:

nomeabbrpagina: Nome da página abreviado

nomeabbrcomponente: nome do componente abreviado

identificador: identificador numérico único incrementado de 1 a N, onde N são os componentes na pagina.

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. Os endpoints utilizados estão documentados no Postman.

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

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

kobe-swagger.yml