Skip to content

GitLab

  • Menu
Projects Groups Snippets
    • Loading...
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in
  • W Wiki
  • Project information
    • Project information
    • Activity
    • Labels
    • Planning hierarchy
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 0
    • Issues 0
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • EasyWork
  • Wiki
  • Wiki
  • 9. rotas api

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

9. rotas api

# DOWNLOAD ARQUIVOS POSTMAN



# API BACK-AUTH-SERVICE

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


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)

<br>
<br>



# # API BACK-RESEARCH-SERVICE
## `ATENÇÃO: NECESSÁRIO ESTAR COM O BANCO DE DADOS, O PROJETO DE AUTENTICAÇÃO (auth-api) E O PROJETO DE PESQUISAS (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 PESQUISAS
#### GET em [url]/api/researches/
#### GET em [url]/api/researches/{researchId}
#### GET em [url]/api/researches/allresearches/{status}

<br>
<br>

## ATUALIZANDO PESQUISA
(possíveis ROLES: <b>ROLE_RESEARCHER</b>)
<br>
#### PUT em [url]/api/researches/{researchId}

<br>
<br>
## EXCLUINDO PESQUISA
(possíveis ROLES: <b>ROLE_RESEARCHER</b>, <b>ROLE_ADMIN</b>)
<br>
#### DELETE em [url]/api/researches/{researchId}

<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}

<br>
<br>

## PUBLICANDO PESQUISAS DO PESQUISADOR LOGADO
Necessário usar a autenticação de um Pesquisador (ROLE_RESEARCHER)
#### PUT em [url]/api/researches/publish/{researchId}

<br>
<br>

## PAUSANDO PESQUISAS DO PESQUISADOR LOGADO
Necessário usar a autenticação de um Pesquisador (ROLE_RESEARCHER)
#### PUT em [url]/api/researches/stop/{researchId}

<br>
<br>

## ENCERRANDO PESQUISAS DO PESQUISADOR LOGADO
Necessário usar a autenticação de um Pesquisador (ROLE_RESEARCHER)
#### PUT em [url]/api/researches/finish/{researchId}

<br>
<br>



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

<br>

## CADASTRO DE RESPOSTA PARA UMA PESQUISA
#### POST em [url]/api/responses/start/{researchId}
(possíveis ROLES: <b>ROLE_RESPONDENT</b>)
<br>
É iniciado período de resposta do respondente (status STARTED)

<br>
<br>

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

<br>
<br>


## OBTENDO RESPOSTAS DO RESPONDENTE LOGADO
Necessário usar a autenticação de um Respondente (ROLE_RESPONDENT)
#### GET em [url]/api/researches/myresponses
#### GET em [url]/api/researches/myresponses/{status}


<br>
<br>

## FINALIZAR UMA RESPOSTA PARA UMA PESQUISA
#### PUT em [url]/api/responses//finish/{researchId}
(possíveis ROLES: <b>ROLE_RESPONDENT</b>)
É finalizado período de resposta do respondente (status PENDING)


<br>
<br>

## APROVAR UMA RESPOSTA PARA UMA PESQUISA
#### PUT em [url]/api/responses/finish/{responseId}
(possíveis ROLES: <b>ROLE_RESEARCHER</b>)
É finalizado período de resposta do respondente (status APPROVED)


<br>
<br>

## REJEITAR UMA RESPOSTA PARA UMA PESQUISA
#### PUT em [url]/api/responses/refuse/{responseId}
(possíveis ROLES: <b>ROLE_RESEARCHER</b>)
É finalizado período de resposta do respondente (status REFUSED)

<br>
<br>
Clone repository
  • 1. home
  • 2. cronograma
  • 3. time
  • 4. pivotal labs
  • 5. requisitos
  • 6. mockups de tela
  • 7. arquitetura
  • 8. modelagem de dados
  • 9. rotas api
  • :10. tutorial de instalacao do projeto
  • :11. tecnologias
  • Home