-
Notifications
You must be signed in to change notification settings - Fork 3
API eFix
A API foi desenvolvida em Node.js e posta online na Google Cloud Plataform.
O arquivo eFix/eFix/src/services/API.js fornece funções de encapsulamento para realizar as requisições.
Para isso é necessário realizar a importação do arquivo para poder utilizá-las. No cabeçalho do arquivo deve-se inserir
import api from './services/API';
Isto supondo que o arquivo no qual está sendo feita a importação se encontra na pasta eFix/eFix/src/
Assim as funções estarão visíveis para serem usadas.
Os métodos da API são de acesso assíncrono aos dados contidos no Firebase. Portanto, para utilizá-los se faz necessário o uso do prefixo await antes da chamada do método. Exemplo:
const response = await api.getServices();
Recupera todos os serviços cadastrados.
O método não recebe nenhum argumento.
O método retorna um json com um único campo chamado "servicos" que tem como valor um array contendo um json por elemento, sendo estes por sua vez representam um serviço específico com todos os seus dados. O método retorna um um erro caso seja impossível realizar a recuperação dos serviços.
Retorna todos os serviços de uma categoria específica.
O método recebe como argumento uma String com o nome da categoria que deve ser retornada.
O método retorna um json com um único campo chamado "servicos" que tem como valor um array contendo um json por elemento, sendo estes por sua vez representam um serviço específico com todos os seus dados. O método retorna um um erro caso seja impossível realizar a recuperação dos serviços.
Retorna um serviço específico.
O método recebe como argumento uma String com o ID do serviço que deve ser retornado.
O método retorna um json com um único campo chamado "servicos" que tem como valor um array contendo um json por elemento, sendo estes por sua vez representam um serviço específico com todos os seus dados.
O método retorna um um erro caso seja impossível realizar a recuperação do serviço.
Retorna um serviço específico.
O método recebe como argumento uma String com o valor máximo dos serviços que devem ser retornados.
O método retorna um json com um único campo chamado "servicos" que tem como valor um array contendo um json por elemento, sendo estes por sua vez representam um serviço específico com todos os seus dados.
O método retorna um um erro caso seja impossível realizar a recuperação do serviço.
Retorna todos os serviços que contenham no nome as palavras informadas. Palavras com menos de 3 caracteres são desconsideradas.
O método recebe como argumento uma String com as palavras que o nome do serviço deve ter para ser retornado.
O método retorna um json com um único campo chamado "servicos" que tem como valor um array contendo um json por elemento, sendo estes por sua vez representam um serviço específico com todos os seus dados. O método retorna um um erro caso seja impossível realizar a recuperação dos serviços.
Cria um serviço novo no banco de dados.
O método recebe como argumento um json contendo os dados do novo serviço. O json deve ser o seguinte formato:
{
"categoria": "Jardinagem",
"descricao": "Aparo sua grama baratinho",
"id_prestador": "zeca0332",
"id_servico": "suadh0uhu1uh232ewqeq1",
"nome": "Aparo de Grama",
"preco": "20"
}
O método retorna um um erro caso seja impossível realizar a criação do serviço.
Cria uma categoria com os dados fornecidos no banco de dados.
O método recebe um json contendo os dados da nova categoria como argumento.
{
"id": "c001",
"nome": "Encanador"
}
O método retorna um um erro caso seja impossível realizar a criação da categoria.
Recupera todos as categorias cadastradas.
O método não recebe nenhum argumento.
O método retorna um json com um único campo chamado "categorias" que tem como valor um array contendo um json por elemento, sendo estes por sua vez representam uma categoria específica com todos os seus dados.
"categorias": {
[
{
"id": "c001",
"nome": "Encanador"
},
{
"id": "c002",
"nome": "Eletricista"
}
]
}
Atualiza o nome de uma categoria.
O método recebe um json no formato demonstrado contendo o novo nome e o id original como argumento.
O método retorna um um erro caso seja impossível realizar a criação da categoria.
Deleta uma categoria.
O método recebe um json no formato demonstrado representando a categoria a ser deletada como argumento.
O método retorna um um erro caso seja impossível realizar a criação da categoria.
Cria no banco de dados um usuário com os dados fornecidos.
O método recebe um json contendo os dados da novo usuário como argumento.
{
"nome": "Xonas Texeiro",
"senha": "cabadapeste",
"email": "meuemail@example.com",
"endereco": "Rua do Cangaço, 34555, ZP, Teresina, PI"
}
O método retorna um um erro caso seja impossível realizar a criação.
Recupera todos os dados de um usuário.
O método recebe um id de usuário como argumento.
O método retorna um json que representa um usuário com todos os seus dados.
Atualiza os dados de um usuário.
O método recebe um json no formato demonstrado contendo o os novos valores como argumento.
O método retorna um um erro caso seja impossível realizar a atualização.
Deleta um usuário.
O método recebe um id do usuário a ser deletado como argumento.
O método retorna um um erro caso seja impossível deletar.
Cria no banco de dados um prestador com os dados fornecidos.
O método recebe um json contendo os dados do novo prestador como argumento.
{
"id_usuario": "óusbduaishbahuydtd3lj44hb13oysdoasgtudo3jg4134o1",
"bio": "Sou um eletricista muito louco"
}
O método retorna um um erro caso seja impossível realizar a criação.
Recupera todos os dados de um prestador de serviços.
O método recebe um id de prestador como argumento.
O método retorna um json que representa um prestador com todos os seus dados.
Recupera todos os prestadores cadastrados.
O método não recebe nenhum argumento.
O método retorna um json com um único campo chamado "prestadores" que tem como valor um array contendo um json por elemento, sendo estes por sua vez representam um prestador específico com todos os seus dados.
Atualiza os dados de um prestador.
O método recebe um json no formato demonstrado contendo o os novos valores como argumento.
O método retorna um um erro caso seja impossível realizar a atualização.
Deleta um prestador.
O método recebe um id do prestador a ser deletado como argumento.
O método retorna um um erro caso seja impossível deletar.
Troca o status de um prestador.
O método recebe um id do prestador a ser atualizado como argumento.
O método retorna um um erro caso seja impossível modificar.
Cria no banco de dados um contrato com os dados fornecidos.
O método recebe um json contendo os dados do novo contrato como argumento.
{
"id_prestador": "2f5f7bbeb1024442922992ab22383faae088e3b35957909979dfb65233876c6e",
"id_usuario": "34d61fb7f20eb7e0538544b4b09bfb429b02ddc704a3b7f66ab75cb5ba438397",
"id_servico": "a05f51c3bbb449a2b391926af22bd510be1acc7995237c69d0e3961cc8d680cb",
"data": "10/11/2019"
}
O método retorna um um erro caso seja impossível realizar a criação.
Recupera todos os contratos.
O método não recebe nenhum argumento.
O método retorna um json com um único campo chamado "contratos" que tem como valor um array contendo um json por elemento, sendo estes por sua vez representam um contrato específico com todos os seus dados.
Recupera todos os dados de um contrato.
O método recebe um id de contrato commo argumento.
O método retorna um json que representa um contrato com todos os seus dados.
Atualiza os dados de um contrato.
O método recebe um json no formato demonstrado contendo o os novos valores como argumento.
O método retorna um um erro caso seja impossível realizar a atualização.
Deleta um contrato.
O método recebe um id do contrato a ser deletado como argumento.
O método retorna um um erro caso seja impossível deletar.
Troca o status de um contrato para encerrado.
O método recebe um id do contrato a ser atualizado como argumento.
Recupera todos os contratos de um usuário.
O método recebe um id de usuário como argumento.
O método retorna um json com um único campo chamado "contratos" que tem como valor um array contendo um json por elemento, sendo estes por sua vez representam um contrato específico com todos os seus dados.
Recupera todos os contratos de um prestador.
O método recebe um id de prestador como argumento.
O método retorna um json com um único campo chamado "contratos" que tem como valor um array contendo um json por elemento, sendo estes por sua vez representam um contrato específico com todos os seus dados.
Adiciona uma avaliação ao contrato.
O método recebe um id de contrato como argumento.
O método não retorna nada em caso de sucesso. Ou um erro em caso de falha.