afa4 / digito-unico

API Dígito Único

A API Dígito Único disponibiliza recursos para cadastro e criptografia de informações de usuários, endpoit para cálculo avulso do dígito único de um inteiro e enpoint para registro de cálculo de dígito único para um usuário.

Tecnologias utilizadas

JAVA 11 MAVEN SPRING-BOOT SPRING-DATA-JDBC* H2-DATABASE JUNIT MOCKITO SWAGGER

*Escolhi jdbc para demonstrar minhas habilidades na construção de DAOs "from scratch" :)

Build, testes e execução ☕

Antes de quaisquer das ações seguintes é necessário acessar a pasta raiz do projeto após a clonagem/ download do repositório (cd digito-unico/).

• Para build e download das dependências utilize o comando:

  • ./mvnw install

• Para executar os testes unitários utilize o comando:

  • ./mvnw test

• Para executar a aplicação (após o build) utilize o comando:

  • ./mvnw spring-boot:run

• Para empacotar a aplicação (geração do arquivo .jar) utilize:

  • ./mvnw package

Documentação da api ✏️

A aplicação disponibiliza a documentação da api no recurso /swagger-ui.html

Lá encontram-se as descrições de todos os endpoints da API

Também é possível gerar a documentação open-api versão 3.0 através dos recursos

/v3/api-docs em formato json .json

/v3/api-docs.yaml em formato .yaml

Sobre o cálculo do 'Digito Único' 💡

API que disponibiliza cálculo do dígito único a partir de uma representação de inteiro em formato String.

input: String number int repeatTimes

output: int singleDigit

Exemplo de cálculo do dígito único de um inteiro

getSingleDigit("9875", 4)

getSingleDigit("9875987598759875")

getSingleDigit("9 + 8 + 7 + 5 + 9 + 8 + 7 + 5 + 9 + 8 + 7 + 5 + 9 + 8 + 7 + 5")

getSingleDigit("116")

getSingleDigit("1 + 1 + 6")

getSingleDigit("8")

8