Importar Documentação do Postman:
Existe uma documentação dos endpoints da aplicação. Primeiramente é necessário fazer o clone do projeto e instalação de suas depências.
A doc pode ser gerada pelo comando do bash:
Code Block |
---|
npm run generateDoc |
Ao rodar esse comando será gerado dois arquivos com o nome de openapi.json e postman.json que serão salvos dentro da pasta app da aplicação como mostrado na figura
...
Para a visualização é necessário baixar e instalar o POSTMAN.
Com o postman instalado é necessário clicar no icone “hamburguer” (icone com 3 linhas paralelas horizontalmente) encontrado no canto superior esquerdo da tela
...
Nesse icone ir na opção file (arquivo) → import (importar) ou usar o comando ctrl+ O. Após feito, navegar até o diretório app do projeto e selecionar o arquivo postman.json.
...
Após importar os endpoints estarão na parte de Collections (coleções) do postman.
...
Distribuição de Obras:
Já existe:
...