From cda44008fbea0a85d99da07506837644b7c9100c Mon Sep 17 00:00:00 2001 From: Thiago Date: Fri, 21 May 2021 00:46:57 -0300 Subject: [PATCH] [266] update readme with new functions Co-authored-by: Dafne Moretti Signed-off-by: Thiago --- README.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a668b39..1216afa 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,14 @@ Caso reste duvidas você também pode entrar em contato conosco criando uma issu A documentação do projeto pode ser acessada pelo nosso site em https://fga-eps-mds.github.io/2020-2-SiGeD/ ou você pode acessar pela [SiGeD Documentação](https://fga-eps-mds.github.io/2020-2-SiGeD/home/) +## Testes + +Todas as funções adicionadas nessa API devem ser testadas, o repositŕorio aceita até 10% do total de lihas não testadas. Para rodar os testes nesse repositŕio deve ser executado o comando: + +```bash +docker-compose run backend_sector bash -c "yarn && yarn jest --coverage --forceExit" +``` + ## Como rodar? Para rodar a API é preciso usar os seguintes comandos usando o docker: @@ -42,6 +50,10 @@ Para receber os dados dos setores. Para receber os dados de um setor específico utilizando o `id`. +**GET: `/sector/newest-four`** + +Para receber os dados dos últimos quatro setores adicionados. + **POST: `/sector/create`** Para criar um novo setor, envie os dados nesse formato: @@ -67,4 +79,3 @@ Para atualizar os dados do setor, envie os dados atualizados seguindo o padrão: **DELETE: `/sector/delete/:id`** Para deletar um setor pelo `id`. -