| ... | @@ -54,26 +54,17 @@ Aqui serão apresentadas as convenções de desenvolvimento. Padrões, documenta |
... | @@ -54,26 +54,17 @@ Aqui serão apresentadas as convenções de desenvolvimento. Padrões, documenta |
|
|
|
|
|
|
|
## Guidelines de chamadas para o Firebase
|
|
## 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.
|
|
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/).
|
|
|
|
Os endpoints utilizados estão documentados no [Postman](https://documenter.getpostman.com/view/15953979/2s93XvX5Ba).
|
|
|
|
|
|
|
|
**Abaixo está o swagger relativo à API. Este pode ser visualizado no link: [Editor Swagger](https://editor.swagger.io)**
|
|
|
|
|
|
|
|
|
|
[kobe-swagger.yml](uploads/6ffd52c17a844400343003416cf22b79/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}`
|
|
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:
|
|
|
|
|
|
|
|
Faz o fetch de um item específico de uma coleção no Firestore.
|
|
|
|
|
|
|
|
|
|
##### Exemplo: `/documents/feature/U9JnchPOqvWaC0sfNQ9I`
|
|
Nesse exemplo, o Restapify nos retorna o mock de features na URL `http://localhost:6767/api/documents/feature`
|
|
|
|
|
|
|
|
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:
|
|
|
|
|
|
|
|
|
|
|
|
**Abaixo está o swagger relativo à API. Este pode ser visualizado no link: [Editor Swagger](https://editor.swagger.io)**
|
|
|
|
|
|
|
|
Nesse exemplo, o Restapify nos retorna o mock de features na URL `http://localhost:6767/api/documents/feature` |
|
[kobe-swagger.yml](uploads/6ffd52c17a844400343003416cf22b79/kobe-swagger.yml) |
|
\ No newline at end of file |
|
\ No newline at end of file |
