Projeto • Instalação • Testes e Cobertura • Build e Análise • EndPoints • Licença
-------Serviço de API Rest para geração de boletos. Pode ser consumido por um módulo de um sistema, onde é possível gerar um boleto, pagar um boleto, cancelar um boleto e calcular os juros conforme a data de vencimento.
Este projeto utiliza Maven para build e gerenciamento das dependências e foi construído utilizando a stack do WildFly Swarm. Efetuar o download do projeto e executar o build através da linha de comando na pasta raiz do projeto:
mvn clean wildfly-swarm:run
Este projeto utiliza JUnit 5 para testes unitários e de integração. Você pode executar os testes a qualquer momento. Tudo o que você precisa fazer é executar a linha de comando na pasta raiz do projeto:
mvn clean test
- O build remoto do projeto pode ser visualizado com: Travis CI.
- A análise de código pode ser visualizada com: SonarCLoud.
EndPoints disponíneis para utilização do serviço.
Geração do Boleto: POST: http://localhost:8080/rest/bankslips
{
"due_date": "2018-05-10",
"total_in_cents": "1500",
"customer": "Bankslip Company",
"status": "PENDING"
}
Lista de Boletos: GET: http://localhost:8080/rest/bankslips/
[
{
"id": "77a2d41e-4b50-42e4-a5fd-32ed85bd3bb2",
"due_date": "2018-05-04",
"total_in_cents": 15000.000,
"customer": "Bankslip Company",
"status": "PENDING"
},
{
"id": "5b5ab681-4300-4757-9893-bf4aa63eede5",
"due_date": "2018-05-10",
"total_in_cents": 10.000,
"customer": "Bankslip Company",
"status": "PENDING"
}
]
Detalhes do Boleto: GET: http://localhost:8080/rest/bankslips/{id}
{
"id": "77a2d41e-4b50-42e4-a5fd-32ed85bd3bb2",
"due_date": "2018-05-04",
"total_in_cents": 15000.000,
"customer": "Bankslip Company",
"status": "PENDING"
}
Pagar um Boleto: PUT: http://localhost:8080/rest/bankslips/{id}
{
"status": "PAID"
}
Cancelar um Boleto: PUT: http://localhost:8080/rest/bankslips/{id}
{
"status": "CANCELED"
}
Este projeto está licenciado sob os termos da licença do MIT. Veja o arquivo LICENÇA.