Code Monkey home page Code Monkey logo

bankslip's Introduction

Bankslip

License Build Status GitHub forks GitHub stars SonarQube Coverage


ProjetoInstalaçãoTestes e CoberturaBuild e AnáliseEndPointsLicença

-------

Projeto

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.

Instalação

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

Testes e Cobertura

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

Build e Análise

  • O build remoto do projeto pode ser visualizado com: Travis CI.
  • A análise de código pode ser visualizada com: SonarCLoud.

EndPoints

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

Licença

Este projeto está licenciado sob os termos da licença do MIT. Veja o arquivo LICENÇA.

bankslip's People

Contributors

vcampanholi avatar

Stargazers

 avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.