ewally-desafio-api 💰
API que recebe linhas digitáveis, faz algumas validações e retorna informações de código de barras, data de vencimento(se existir) e valor(se existir).
Você precisa instalar Node.js. Você pode instalar também Yarn como alternativa para gerenciar as dependências.
Clone o repositório: https://github.com/luisrabock/ewally-desafio
💻 Development environment:
Na pasta raiz do projeto você deve rodar os comandos:
yarn install ou npm install
Para subir a API com nodemon:
yarn dev ou npm run dev
A aplicação está rodando na porta 4000!!
🧪 Tests environment:
Na pasta raiz do projeto você deve rodar os comandos:
yarn test ou npm run test
Será apresentado o coverage aproximado.
📋 Docs:
REST Client Vs Code -
No caminho: pastaRaiz\src\docs\rest existe um arquivo billet.http. Com a extensão REST Client instalada no vscode, é possivel executar requisições nesse arquivo.
OpenAPI(Swagger) -
Nessa API também existe uma documentação feita com OpenAPI(swagger), ali existem detalhes da response e também o formato do erro que pode retornar. Aqui também é possivel executar requisições, ela está dísponivel em: http://localhost:4000/api-docs.
Outras opções para consumir a API -
Outra opção é usar alguma ferramenta(postman, insomnia ) para fazer as requisições.
Método: GET
Endpoint: http://localhost:4000/api/v1/boleto/
Param: {payNumber}
O conteúdo de ewally-desafio-api está licenciado sob os termos da MIT License MIT License.