|
|
|
| [Home](home) | [Escopo e Cronograma](escopo) | [Processo](processo) | [Design/Mockups](design_mockups) | [**Configuração**](configuracao) | [Arquitetura](arquitetura) | [Código](codigo) | [BD](banco_dados) | [Qualidade](qualidade) | [Utilização](utilizacao) |
|
|
|
|
| :----------: | :---------------------------: | :------------------: | :--------------: | :------------------------------: | :------------------------: | :--------------: | :---------------: | :--------------------: | :----------------------: |
|
|
|
|
| [Home](home) | [Gerência](gerencia) | [Processo](processo) | [Design/Mockups](design_mockups) | [_Configuração_](configuracao) | [Arquitetura](arquitetura) | [Código](codigo) | [Banco de Dados](banco_dados) | [Utilização](utilizacao) |
|
|
|
|
| :----------: | :------------------: | :------------------: | :------------------------------: | :----------------------------: | :------------------------: | :--------------: | :---------------------------: | :----------------------: |
|
|
|
|
|
|
|
|
# Configurações do Projeto
|
|
|
|
|
| ... | ... | @@ -59,42 +59,41 @@ Baixe o [Visual Studio Code](https://code.visualstudio.com/) e, para auxiliar no |
|
|
|
|
|
|
|
No repositório do [backend](https://tools.ages.pucrs.br/autis/autis-backend) do projeto, podemos ver no README as informações referentes a configuração da máquina, compiliação e execução.
|
|
|
|
|
|
|
|
|
|
|
|
### Realizando requisições com Postman
|
|
|
|
|
|
|
|
Uma vez que o backend da aplicação está configurado e sendo executado, recomenda-se o uso da plataforma Postman como cliente HTTP para realizar as requisições para a API a partir de uma interface gráfica. O Postman, que pode ser instalado [neste link](https://www.postman.com/downloads/), é a ferramenta utilizada para gerar a documentação da API do Autis, que a equipe escolheu por ser fácil de utilizar.
|
|
|
|
|
|
|
|
Esta documentação está publicada e pode ser acessada aqui: https://documenter.getpostman.com/view/12268975/UVyyrsC6
|
|
|
|
Esta documentação está publicada e pode ser acessada aqui: <https://documenter.getpostman.com/view/12268975/UVyyrsC6>
|
|
|
|
|
|
|
|
Esta documentação está organizada em uma *collection* do Postman, que é basicamente um diretório onde você pode organizar as suas requisições e outros elementos de sua API, como variáveis ou testes. Nesta *collection* as requisições estão organizadas em diretórios de acordo com a entidade a qual são relacionadas (ex.: Material ou Usuário), e em cada pasta estão as requisições possíveis que podem ser feitas para cada caso, como visto na imagem abaixo:
|
|
|
|
Esta documentação está organizada em uma _collection_ do Postman, que é basicamente um diretório onde você pode organizar as suas requisições e outros elementos de sua API, como variáveis ou testes. Nesta _collection_ as requisições estão organizadas em diretórios de acordo com a entidade a qual são relacionadas (ex.: Material ou Usuário), e em cada pasta estão as requisições possíveis que podem ser feitas para cada caso, como visto na imagem abaixo:
|
|
|
|
|
|
|
|
<img src="./resources/images/postman/collection.png" width="220">
|
|
|
|
|
|
|
|
Assim, existe na documentação uma requisição para cada endpoint da API que foi implementado, e a partir dos dados de exemplo já preenchidos nessa requisição, é possível fazer alterações para construir a requisição desejada. Na imagem abaixo está um exemplo de requisição para criar um professor no banco de dados, e as setas destacam algumas das informações que podem ser alteradas para personalizar a requisição (e.g.: *path parameters* na URL ou corpo da requisição).
|
|
|
|
Assim, existe na documentação uma requisição para cada endpoint da API que foi implementado, e a partir dos dados de exemplo já preenchidos nessa requisição, é possível fazer alterações para construir a requisição desejada. Na imagem abaixo está um exemplo de requisição para criar um professor no banco de dados, e as setas destacam algumas das informações que podem ser alteradas para personalizar a requisição (e.g.: _path parameters_ na URL ou corpo da requisição).
|
|
|
|
|
|
|
|
<img src="./resources/images/postman/requisicao.png" width="650">
|
|
|
|
|
|
|
|
Uma vez que a requisição é enviada, a resposta é apresentada na tela, como ilustrado na figura abaixo. Ao clicar na opção *Save response*, você pode salvar a resposta retornada como exemplo, e por isso sugere-se sempre salvar um exemplo de resposta de sucesso e de erro, para que se entenda o formato da resposta da API em cada situação ao ler a documentação.
|
|
|
|
Uma vez que a requisição é enviada, a resposta é apresentada na tela, como ilustrado na figura abaixo. Ao clicar na opção _Save response_, você pode salvar a resposta retornada como exemplo, e por isso sugere-se sempre salvar um exemplo de resposta de sucesso e de erro, para que se entenda o formato da resposta da API em cada situação ao ler a documentação.
|
|
|
|
|
|
|
|
<img src="./resources/images/postman/resposta.png" width="500">
|
|
|
|
|
|
|
|
Para que o time possa realizar as requisições para a API usando esta *collection*, ela deve ser exportada como um arquivo JSON após cada alteração na documentação e ser commitada no repositório de backend, estando disponível aqui: https://tools.ages.pucrs.br/autis/autis-backend/-/blob/dev/AUTIS-Backend.postman_collection.json
|
|
|
|
Para que o time possa realizar as requisições para a API usando esta _collection_, ela deve ser exportada como um arquivo JSON após cada alteração na documentação e ser commitada no repositório de backend, estando disponível aqui: <https://tools.ages.pucrs.br/autis/autis-backend/-/blob/dev/AUTIS-Backend.postman_collection.json>
|
|
|
|
|
|
|
|
:warning: Para manter essa collection atualizada, sugere-se que a cada novo endpoint ou correção importante, esta documentação seja atualizada e commitada novamente junto ao *merge request* da tarefa.
|
|
|
|
:warning: Para manter essa collection atualizada, sugere-se que a cada novo endpoint ou correção importante, esta documentação seja atualizada e commitada novamente junto ao _merge request_ da tarefa.
|
|
|
|
|
|
|
|
Para realizar as requisições para a API a partir deste arquivo, siga os passos abaixo:
|
|
|
|
|
|
|
|
1. Selecione a opção de *Import* na interface do Postman
|
|
|
|
|
|
|
|
<img src="./resources/images/postman/importar.png" width="200">
|
|
|
|
1. Selecione a opção de _Import_ na interface do Postman
|
|
|
|
|
|
|
|
<img src="./resources/images/postman/importar.png" width="200">
|
|
|
|
|
|
|
|
2. Selecione a opção *Upload files* e faça o upload do arquivo JSON.
|
|
|
|
2. Selecione a opção _Upload files_ e faça o upload do arquivo JSON.
|
|
|
|
|
|
|
|
<img src="./resources/images/postman/importar2.png" width="460">
|
|
|
|
<img src="./resources/images/postman/importar2.png" width="460">
|
|
|
|
|
|
|
|
3. Confirme a importação e então a *collection* estará visível em seu *workspace*.
|
|
|
|
3. Confirme a importação e então a _collection_ estará visível em seu _workspace_.
|
|
|
|
|
|
|
|
<img src="./resources/images/postman/importar3.png" width="460">
|
|
|
|
<img src="./resources/images/postman/importar3.png" width="460">
|
|
|
|
|
|
|
|
## Frontend
|
|
|
|
|
| ... | ... | @@ -111,4 +110,4 @@ Para realizar as requisições para a API a partir deste arquivo, siga os passos |
|
|
|
|
|
|
|
### Configurando a Máquina para ambiente Frontend
|
|
|
|
|
|
|
|
No repositório do [frontend](https://tools.ages.pucrs.br/autis/autis-frontend) do projeto, podemos ver no README as informações referentes a configuração da máquina, compiliação e execução. |
|
|
\ No newline at end of file |
|
|
|
No repositório do [frontend](https://tools.ages.pucrs.br/autis/autis-frontend) do projeto, podemos ver no README as informações referentes a configuração da máquina, compiliação e execução. |
