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:
PWD é uma solução de sandbox do Docker que possibilita a execução de containers para fins de testes em segundos.
- Docker
- Docker Compose
- PWD - Play With Docker (It's alternative to expose the mock through internet running in the cloud).
-
Baixe e instale o Docker e o Docker Compose..
-
Crie um fork desse repositório no Github.
-
Clone seu repositório forked (não o original) para sua máquina
git clone https://github.com/YOURUSERNAME/mock-api.git- Accesse o diretório mock-api.
cd mock-api- 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- 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- 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/metricsSe tudo estiver OK, você receba uma resposta para a requisição semelhante a esta:
- Acesse PWD and inicie uma nova sessão com suas credências do Docker Hub.
- Uma vez logado, clique em "Add New Instance".
- Uma nova instância será iniciada com o Docker pronto para uso.
- Agora rode o comando abaixo:
docker run -p 7001:7001 openbankingbrasil/admin-api:v1.0.0-rc5.3O Docker vai realizar o download da imagem e iniciar o container. No fim do processo será exibida a mensagem "Starting server on port 7001".
- Agora é possível clicar na porta 7001 conforme destacado abaixo:
- Será exibida uma tela branca com a seguinte mensagem:
- 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.
- Todos as url´s das API´s podem ser verificadas em Open Banking Developer Portal
