Test Repassa API

Instalação

NOTA: Para executar qualquer um dos comandos abaixo, é imprescindível ter o gerenciador de dependencia NPM instalado globalmente em seu computador, e nagevar para dentro do diretório root da aplicação para que todos os comandos possam ser executados com sucesso.

Instalação local

Para fazer a instalação de todas as dependencias da aplicação, execute a seguinte linha de comando no terminal.

npm install

Nota: Se após a intalação você receber informações de vulnerabilidades nas dependencias instaladas, execute o seguinte comando para corrigir eventuais vulnerabilidades.

npm audit fix && npm audit fix --force

Modo desenvolvimento

Os arquivos do código fonte da aplicação estão contidos dentro do diretório ./src. Após concluir a instalação de todas as dependencias da aplicação, é possível executar o comando de desenvolvimento no terminal.

npm run dev

Depois de executar o comando acima, a aplicação estará pronta para receber as requisições a partir dos endpoints da API. A aplicação sera recompilada sempre que você salvar um arquivo, você também verá quaisquer eventuais erros no código no seu console.

Modo debugger

npm run debugger

Construção (Transpilar)

Este comando cria os arquivos de produção dentro do diretório ./build. Os arquivos de produção são transpilados e compilados para a versão ES5 do JS atraves do Babel. Para construir a aplicação em modo producão, execute o seguinte comando:

npm run build

Modo produção

Com esse comando será inicializado um servidor Express que executa os arquivos de produção no diretório ./build, que por padrão, busca o arquivo index.js.

npm run start

Nota: Se você quiser publicar o projeto com o comando npm run start, não esqueça de ajustar o caminho relativo no arquivo ./package.json na propriedade homepage:.

Uso da API

Esta API faz operações CRUD a partir de requisições recebidas via protocolo HTTP. A URL base da API em questão é:

https://repassa-api.herokuapp.com/api

Criar novo funcionário - POST

Para criar um novo funcionário, basta enviar uma requisição com o método POST passando os parametros name, login, feedback e o prefixo /create logo após a URL base da API. Desta forma a requisição deve ser assim:

https://repassa-api.herokuapp.com/api/create?name=kiko&login=tesouro&feedback=Criança mimada, e não muito inteligente.

Esta requisição returna o objeto criado.

Atualizar funcionário - PUT

Para atualizar um funcionário, basta enviar uma requisição com o método PUT passando os parametros name, login, feedback, e informar o ID do funcionário logo após a URL base da API. Desta forma a requisição deve ser assim:

https://repassa-api.herokuapp.com/api/5def8be15ee04b004c0ab78d?name=kiko&login=tesouro&feedback=Criança mimada, e não muito inteligente.

Esta requisição returna o objeto atualizado.

Deletar funcionário - DELETE

Para deletar um funcionário, basta enviar uma requisição com o método DELETE com o respectivo ID do funcionário logo após a URL base da API. Desta forma a requisição deve ser assim:

https://repassa-api.herokuapp.com/api/5def8be15ee04b004c0ab78d

Esta requisição returna o objeto deletado.

Buscar funcionário - GET

Para buscar um funcionário, basta enviar uma requisição com o método GET com o respectivo ID do funcionário logo após a URL base da API. Desta forma a requisição deve ser assim:

https://repassa-api.herokuapp.com/api/5def8be15ee04b004c0ab78d

Esta requisição returna o objeto do usuário identificado pelo seu _ID.

Listar todos funcionários - GET

Para listar todos funcionários, basta enviar uma requisição com o método GET com o sufixo /list logo após a URL base da API. Desta forma a requisição deve ser assim:

https://repassa-api.herokuapp.com/api/list

Esta requisição returna um array com todos os objetos dos usuários persistidos na base.

i-espinola/test-repassa-api