Skip to content

GitLab

Last edited by Gabriel Fanto Stundner
Page history
This is an old version of this page. You can view the most recent version or browse the history.

9. rotas api

ATENÇÃO:

NECESSÁRIO ESTAR COM O BANCO DE DADOS E O PROJETO DE AUTENTICAÇÃO RODANDO


Arquivos postman:

DOWNLOAD ARQUIVOS POSTMAN


CADASTRO

POST em [url]/api/auth/signup

(possíveis ROLES: ROLE_RESEARCHER, ROLE_RESPONDENT, ROLE_ADMIN) 

	"name":"Diego Osmarin Basso",
	"username":"dob",
	"email":"dob@dob",
	"password":"dobdob",
	"role":"ROLE_ADMIN"
}```

![image](/uploads/8d9cf1b7d8b3bc9c6b300c10fc79902d/image.png)

<br>
<br>

# LOGIN
#### POST em [url]/api/auth/signin
(para o login pode-se usar tanto o username quanto o email cadastrado)
<br>
```{
	"login":"dob",
	"password":"dobdob"
}```

![image](/uploads/e86eed176b3f3764a7ff60359489ece6/image.png)

<br>
<br>

# Usando o TOKEN
#### Exemplo: GET em [url]/api/roles
(Necessário usar um header de <b>Authorization</b> com valor <b>Bearer + token</b>, conforme imagem abaixo)
<br>
![image](/uploads/46222fa8831f5eef8c99a48cda9748f0/image.png)


# ATENÇÃO:
## NECESSÁRIO ESTAR COM O BANCO DE DADOS, O PROJETO DE AUTENTICAÇÃO (back-auth-api) E O PROJETO DE PESQUISAS (back-research-api) RODANDO

<br>

# CADASTRO DE PESQUISA
#### POST em [url]/api/researches
(possíveis ROLES: <b>ROLE_RESEARCHER</b>)

<br>
```{
    "name": "Pesquisa 3",
    "description": "Descrição 3",
    "link": "www.link3.com",
    "numRespondents": 21,
    "maximumResponseTime": 15,
    "estimatedResponseTime": 15,
    "payAmount": 1.35,
    "endDate": "2020-11-11T11:20:00Z"
}```

#### No header é retornada o endereço da pesquisa cadastrada
![image](/uploads/d2c591ad1c42c6665c0a4e834a43fa4f/image.png)

<br>
<br>

# OBTENDO PESQUISA
#### GET em [url]/api/researches/{idResearch}
![image](/uploads/bfb8d5bc709e193740b451a6ac004cb0/image.png)

<br>
<br>

# ATUALIZANDO PESQUISA
(possíveis ROLES: <b>ROLE_RESEARCHER</b>)
<br>
#### PUT em [url]/api/researches/{idResearch}
![image](/uploads/7efed6517cebccbe26c43e05bfdafff2/image.png)

<br>
<br>
# EXCLUINDO PESQUISA
(possíveis ROLES: <b>ROLE_RESEARCHER</b>, <b>ROLE_ADMIN</b>)

<br>

#### DELETE em [url]/api/researches/{idResearch}
![image](/uploads/9703f1b6516a8eaa2e87101fb6d02d56/image.png)

<br>
<br>
<br>

# OBTENDO PESQUISAS DO PESQUISADOR LOGADO
## Necessário usar a autenticação de um Pesquisador (ROLE_RESEARCHER)
#### GET em [url]/api/researches/myresearches
#### GET em [url]/api/researches/myresearches/{status}

# ATENÇÃO: `EM CONSTRUÇÃO`
## NECESSÁRIO ESTAR COM O BANCO DE DADOS, O PROJETO DE AUTENTICAÇÃO (back-auth-api), O PROJETO DE PESQUISAS (back-research-api) E O PROJETO DE RESPOSTAS (back-response-api) RODANDO

<br>

# CADASTRO DE RESPOSTA PARA UMA PESQUISA
#### POST em [url]/api/responses/respondent/start/{researchId}
(possíveis ROLES: <b>ROLE_RESPONDENT</b>)
<br>
#### É iniciado período de resposta do respondente (ver no GET abaixo campos createdAt e status preenchidos)
<br>
![image](/uploads/943f2b6d6b8342d990f56be12348fe0f/image.png)
<br>
<br>

# OBTER DE RESPOSTAS DE UMA PESQUISA
#### GET em [url]/api/responses/research/{researchId}

<br>
![image](/uploads/0758d02d5de446cee37be29932b41003/image.png)
<br>


# FINALIZAR UMA RESPOSTA PARA UMA PESQUISA

#### PUT em [url]/api/responses/respondent/start/{researchId}
(possíveis ROLES: <b>ROLE_RESPONDENT</b>)

<br>

#### É finalizado período de resposta do respondente (preenchido campo respondedAt e alterado campo status para RESPONDIDO)

<br>
![image](/uploads/51334cafabcd42f0fdcd12ebe2290ae5/image.png)