# Clone o repositório e entre na pasta
$ git clone https://github.com/estacao-hack-2020/stay-safe_ajuda-api.git
$ cd stay-safe_ajuda-api
# Instale as dependencias
$ yarn install
# inicialize o banco de dados de teste
$ yarn devdb
# rode o programa
$ yarn devℹ️ : Ele estará disponível no link http://localhost:3333/
GET: /help
- lista a lista de ajudas
Exemplo de Resposta no Response body:
[
{
"id": 1,
"nome": "Lucas",
"telefone": "11984758690",
"email": "lucas@mail.com",
"idade": 26,
"latitude": 12.9048553,
"longitude": -43.9328439,
"mensagem": "mensagem de teste",
"dataCriacao": "2020-12-09T22:57:41.909Z",
"status": "finalizado"
},
{
"id": 2,
"nome": "Lucas 2",
"telefone": "11984758690",
"email": "lucas@mail.com",
"idade": 26,
"latitude": 12.9048553,
"longitude": -43.9328439,
"mensagem": "teste",
"dataCriacao": "2020-12-09T23:31:36.477Z",
"status": "aguardando"
}
]GET: /help/1
- lista uma ajuda pelo id
Exemplo de Resposta no Response body:
{
"id": 1,
"nome": "Lucas",
"telefone": "11984758690",
"email": "lucas@mail.com",
"idade": 26,
"latitude": 12.9048553,
"longitude": -43.9328439,
"mensagem": "mensagem de teste",
"dataCriacao": "2020-12-09T22:57:41.909Z",
"status": "finalizado"
}POST: /help
- cria um novo pedido de ajuda
Exemplo de Request Body aceito:
{
"nome": "Lucas",
"idade": 26,
"mensagem": "mensagem de teste",
"telefone": "11984758690",
"email": "lucas@mail.com",
"latitude": 12.9048553,
"longitude": -43.9328439
}PUT: /help/1
- atualiza um pedido de ajuda pelo id
Exemplo de Request Body aceito:
{
"nome": "Lucas Souza",
"idade": 26,
"mensagem": "mensagem de teste maior",
"telefone": "11984758690",
"email": "lucas@mail.com",
"latitude": 12.9048553,
"longitude": -43.9328439,
"status": "finalizado"
}PATCH /help/1
- atualiza o status de um pedido de ajuda
Exemplo de Request Body aceito:
{
"status": "finalizado
}DELETE: /help/1
- remove um pedido de ajuda pelo id