- This API has documentation generated by Swagger to help understand the requests, however it will be necessary to use a service like Postman, as most requests require the authentication token or some implementation made by the Middleware. is accessible at the URI: /swagger-ui/index.html#/.
- The Users Api development environment is on port 8081.
- The Integration Api development environment is on port 8082.
You must have Docker installed to run the application locally.
-
git clone https://github.com/Maxixee/record-sales-backend.gitTo clone the repository in your IDEdocker-compose -f docker-compose.yml buildTo download images from Postgres, RabbitMQ and the 2 APIsdocker-compose -f docker-compose.yml upTo create containers
-
Once these commands have been carried out, simply build and run the application in your IDE.
- Both APIs were documented by swagger, the documentation can be accessed at the URLs:
- API User:
http://localhost:8081/api/swagger-ui/index.html#/ - API Integration:
http://localhost:8082/api/swagger-ui/index.html#/
- API User:
Authentication is carried out through the endpoint '/api/users/auth', where it performs the POST verb, obtaining the email and password, returning the user's data, in addition to generating an authentication token.
- Essa API possui uma documentação gerada pelo Swagger para auxiliar na compreensão das requisições, porém será necessário utilizar um serviço como Postman, pois grande partes das requisições necessitam do token de autenticação ou de alguma implementação feita pelo Middleware. está acessível na URI: /swagger-ui/index.html#/.
- O ambiente de desenvolvimento da Api de Users está na porta 8081.
- O ambiente de desenvolvimento da Api de Integration está na porta 8082.
É necessário ter o Docker instalado para executar a aplicação localmente.
-
git clone https://github.com/Maxixee/record-sales-backend.gitPara clonar o repositório na sua IDEdocker-compose -f docker-compose.yml buildPara baixar as imagens do Postgres, RabbitMQ e das 2 APIsdocker-compose -f docker-compose.yml upPara criar os containers.
-
Realizados estes comandos, basta buildar e executar o backend na sua IDE.
- Ambas as APIs foram documentadas pelo swagger, as documentações podem ser acessadas nas URLs:
- API User:
http://localhost:8081/api/swagger-ui/index.html#/ - API Integration:
http://localhost:8082/api/swagger-ui/index.html#/
- API User: