laisevn / aprove-me

Este é o repositório utilizado para a realização dos testes seletivos para novos Devs na Bankme

bankme-api

API Repository Github

Sumário

• Sobre o Projeto
• Ambiente de produção
• Ambiente de desenvolvimento
  • Configuração
  • Docker
• Testando API

Sobre o Projeto

É uma API construída com o framework NestJS.

(back to top)

Ambiente de produção

Endereço do ambiente de produção da API: API-bankme.

(back to top)

Ambiente de desenvolvimento

Plugins e dependências

• Node
• NestJs
• Postgres
• Prisma

Para facilitar a instalacao de dependencias recomendo fortemente a ferramenta: ASDF.

(back to top)

Configuração

1. Se você está usando uma os Debian/Ubuntu based básica talvez precise instalar a biblioteca base-devel para instalar as dependências básicas para instalar o ruby e libpq e\ou libpq-dev que a gem pg precisa como pré-requisito. Para Debian ou Ubuntu:

asdf plugin-add nodejs

asdf install nodejs latest
asdf global nodejs

3. Uma vez instalada as dependencias, voce pode executar o servidor.

4. Rode o comando npm run start:dev para iniciar o serviço

(back to top)

Docker

1. Use os comendos para subir o server local com docker:

docker-compose up -d 

docker-compose down -v

2. Para facilitar o desenvolvimento, é recomendável usar o vscode com a extensão do docker.

3. Assim que levantar os serviços com docker-compose, irá parecer a lista dos containers no vscode.

4. Clique com o botão direito em 'Atach bash'

5. Pronto!

(back to top)

Testando a API

POST: /integrations/auth

Autenticando

Parametros

name	type	data type
name	required	string
password	required	string

POST: /integrations/assignor

Criando Assignor

Header

Use o token gerado no retorno da rota de autenticação:

 Authorization: Bearer <token-aqui>

Parametros

name	type	data type
document	required	string
email	required	string
phone	required	string
name	required	string

GET: /integrations/assignor/:id

Visualizar Assignor

Header

Use o token gerado no retorno da rota de autenticação:

 Authorization: Bearer <token-aqui>

DELETE: /integrations/assignor/:id

Deletar Assignor

Header

Use o token gerado no retorno da rota de autenticação:

 Authorization: Bearer <token-aqui>

PUT: /integrations/assignor/:id

Atualizar Assignor

Header

Use o token gerado no retorno da rota de autenticação:

 Authorization: Bearer <token-aqui>

Parametros

name	type	data type
document	optional	string
email	optional	string
phone	optional	string
name	optional	string

POST: /integrations/payable

Criar Payable

Header

Use o token gerado no retorno da rota de autenticação:

 Authorization: Bearer <token-aqui>

Parametros

name	type	data type
value	required	float
emissionDate	required	string
assignor	required	string

PUT: /integrations/payable/:id

Atualizar Payable

Header

Use o token gerado no retorno da rota de autenticação:

 Authorization: Bearer <token-aqui>

Parametros

name	type	data type
value	optional	float
emissionDate	optional	string
assignor	optional	string

DELETE: /integrations/payable/:id

Deletar Payable

Header

Use o token gerado no retorno da rota de autenticação:

 Authorization: Bearer <token-aqui>

GET: /integrations/payable/:id

Viazualizar Payable

Header

Use o token gerado no retorno da rota de autenticação:

 Authorization: Bearer <token-aqui>

(back to top)