Aplicação de Reembolso que inclui uma API para integração e também uma parte WEB para gerir os status, remoção, comprovantes dos reembolsos.
A API foi construida com base nos padrões Rest e sua documentação está disponivel na Documentação do Postman
Foram criados basicamente dois módulos. Um dos módulos denominado Employee fica responsável por gerenciar os funcionarios que possuem reembolsos. Já o outro módulo denominado Refund fica responsável por armazenar os reembolsos de um determinado funcionário.
Tanto a API quanto o painel WEB implementam autenticação. A API implementa a autenticação JWT onde possui um endpoint para realizar o login e retornar o token de acesso.
Para criar um novo usuário, será necessário rodar um seeder presente na aplicação. Esta seeder irá gerar um usuário de exemplo para autenticação tanto web quanto via api.
O projeto foi inicialmente projetado para ter somente a parte da api rest porém com o decorrer do desenvolvimento foi feito um painel administrativo para gerir os reembolsos.
Para isso o projeto em MVC implementa uma camada adicional de Service para comportar melhor as regras da aplicação.
Para rodar a aplicação com todos os recursos e funcionalidades garantidas, recomendo os seguintes passos:
-
Clonar este projeto com
git clone https://github.com/araujodev/reembolso-api.git -
Dentro da pasta clonada executar o
composer install -
A partir do
.env.examplecriar um novo arquivo chamado.env -
Gerar a Key da aplicação com o comando
php artisan key:generatee logo em seguida gerar a key do jwt com o comandophp artisan jwt:secret -
Atualizar os dados do banco de dados no arquivo
.enve executar o migrate comphp artisan migrate -
Executar o Seeder para criar um usuário de exemplo e um funcionário com o comando
php artisan db:seed -
Utilizar os endpoints da api e a parte web para gerenciar a aplicação. Para servir a aplicação execute
php artisan serve
Abaixo deixo a lista dos recursos utilizados:
- tymon/jwt-auth
- nesbot/carbon
- maatwebsite/excel
Att Leandro Souza Araujo.