Thanks to visit codestin.com
Credit goes to github.com

Skip to content

tech4works/gopen-gateway-base

GitHub Playground Docker FOSSA Status

O Gopen API Gateway base é um repositório utilizado para iniciar novos projetos a partir dele, ele tem apenas o básico, com docker-compose e seu esqueleto pronto.

Usabilidade

Para iniciarmos um projeto base da API Gateway, precisamos fazer primeiro a instalação das depêndencias, vamos lá:

Docker

Instale o mesmo seguindo os passos abaixo relacionado ao seu sistema operacional:

Linux

Abra o terminal, atualize os pacotes existentes:

sudo apt-get update

Instale a última versão do Docker:

sudo apt-get install docker-ce

Verifique se o Docker foi instalado corretamente:

sudo docker run hello-world

Baixe a versão estável atual do Docker Compose:

sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o
/usr/local/bin/docker-compose

Aplicar permissões executáveis ao binário:

sudo chmod +x /usr/local/bin/docker-compose

MacOS

Instale Docker para macOS. Lembrando que o Docker-Compose já será instalado junto nesse pacote.

Windows

Instale Docker para Windows. Lembrando que o Docker-Compose já será instalado junto nesse pacote.

Clone

Depois do docker instalado, execute o comando abaixo para clonar o projeto:

git clone https://github.com/tech4works/gopen-gateway-base.git

Execução

Na pasta do seu projeto execute o comando:

docker-compose up

IMPORTANTE

O projeto base vem sem nenhum tipo de configuração pre-definida, o intuito é que você inicie suas configurações e endpoints, caso tenha alguma dúvida leia a documentação.

Observabilidade

Temos algumas configurações pré-definidas com Elastic, após o Kibana ser inicializado basta importar as configurações rodando o comando abaixo:

curl -X POST "localhost:5601/api/saved_objects/_import?overwrite=true" -H "kbn-xsrf: true" --form [email protected] -H "kbn-xsrf: true"

Documentação

Caso ainda não conhece nossa API Gateway, indicamos começar pelo playground, também, disponibilizamos uma documentação completa do projeto em nosso repositório principal.

Como contribuir?

Acesse o repositório principal clicando aqui e veja como contribuir.

Licença Apache 2.0

FOSSA Status

Releases

No releases published