openbanking-brasil / mock-api

Este repositório contém um workflow que gera automaticamente uma imagem docker com um Api Mock baseado no Swagger oficial do Open Banking Brasil.

Projeto: OpenBanking-Brasil | mock-api

Sobre

Esse projeto viabiliza a execução de mocks das apis Open Banking Brasil. Esses mocks são gerados com base na documentação Swagger official através do OpenAPI Mock Server.

Opções para execução:

• 1 - Container Docker local or;
• 2 - Container Docker via PWD-Play with Docker*.

PWD é uma solução de sandbox do Docker que possibilita a execução de containers para fins de testes em segundos.

Dependências

• Docker
• Docker Compose
• PWD - Play With Docker (It's alternative to expose the mock through internet running in the cloud).

Opção 1 - Rodando o container Docker localmente

1. Baixe e instale o Docker e o Docker Compose..

2. Crie um fork desse repositório no Github.

3. Clone seu repositório forked (não o original) para sua máquina

git clone https://github.com/YOURUSERNAME/mock-api.git

4. Accesse o diretório mock-api.

cd mock-api

5. Rode o comando abaixo para iniciar todos os containers. Existe um container para cada uma das API´s.

Esse comando irá baixar as imagens e executar os containers, a versão dos Swaggers considerada será a que consta no arquivo ".env" Por padrão essa versão corresponde com a última publicada.

Se for necessário rodar os containers com uma versão especifica basta editar o arquivo ".env" antes de executar o comando abaixo:

docker-compose up

6. Também é possível rodar um container Docker isoladamente com o comando abaixo:

docker run -p [PORT:PORT] openbankingbrasil/admin-api:[VERSAO]

[PORT]: Cada API-MOCK escuta em uma porta conforme segue:

• ADMIN_API: "7001"
• CHANNELS_API: "7002"
• COMMON_API: "7003"
• PRODUCTS_SERVICES_API: "7004"

[VERSION]: Aqui deve ser informado a versão do Swagger do Open Banking Brasil a ser utilizada
Importante: A versão precisa ser informada de forma explicita, hoje não publicamos imagens Docker com a tag "latest".

Exemplo completo abaixo:

docker run -p 7001:7001 openbankingbrasil/admin-api:v1.0.0-rc5.3

7. Informe a URL abaixo a fim de verificar se o mock está em execução corretamente.

http://localhost:7001/open-banking/admin/v1/metrics

Outra opção é executar se o mock está OK através do CURL:

curl http://localhost:7001/open-banking/admin/v1/metrics

Se tudo estiver OK, você receba uma resposta para a requisição semelhante a esta:

Opção 2 - Rodando o container na nuvem com PWD - Play with Docker

1. Acesse PWD and inicie uma nova sessão com suas credências do Docker Hub.

2. Uma vez logado, clique em "Add New Instance".

3. Uma nova instância será iniciada com o Docker pronto para uso.

4. Agora rode o comando abaixo:

docker run -p 7001:7001 openbankingbrasil/admin-api:v1.0.0-rc5.3

O Docker vai realizar o download da imagem e iniciar o container. No fim do processo será exibida a mensagem "Starting server on port 7001".

5. Agora é possível clicar na porta 7001 conforme destacado abaixo:

6. Será exibida uma tela branca com a seguinte mensagem:

7. Complemente a URL com o path de algum recurso da API em execução, nesse caso da api ADMIN. Será exibida uma resposta mockada conforme abaixo.

8. Todos as url´s das API´s podem ser verificadas em Open Banking Developer Portal

REFERÊNCIAS

• Open Banking Brasil DockerHub
• Open Banking Brasil Developer Portal
• OpenAPI Mock Server
• Docker
• PWD - Play With Docker

mock-api's Issues

Como realizar o deploy em azure.

Olá, gostaria de saber qual o caminho para realizar o deploy dessas imagens como conteiner azure, em vez de local e PWD, se alguem puder apenas apontar o caminho das pedras, desde já agredeço, muito obrigado!!!