Backend

Nesta seção, você encontra o passo a passo da configuração do Beagle no backend.

Requisitos

Antes de integrar o Beagle à sua aplicação para rodá-lo no backend, é importante validar se sua máquina está com as versões corretas instaladas dos seguintes softwares:

  • JDK 8+ language (Kotlin 1.3+ é recomendado)
  • Maven 3+

Se você já tiver atualizado todos estes programas, basta seguir as instruções abaixo.

Instalação

Passo 1: Criar um microsserviço

No momento de criar o microsserviço, recomendamos que você utilize os mesmos mecanismos estabelecidos. Caso este não seja o seu caso, então basta seguir as configurações abaixo.

Para uma configuração simples, você pode escolher entre 2 modelos de frameworks para criar seu BFF:

Micronaut

É um framework full-stack moderno baseado em JVM para construção modular. Fácil de testar em microsserviços e com aplicações sem servidor (serverless).

Spring

É um framework que permite programação em Java mais rápida, fácil e segura para todos. É focada em velocidade, simplicidade e produtividade, o que o tornou o framework Java mais popular.

Depois de selecionar com qual framework deseja seguir, prossiga com as configurações abaixo:

Criando um microsserviço

Micronaut <= 1.3

Conforme descrito no quickstart do Micronaut, crie seu aplicativo através da ferramenta de CLI com o seguinte comando:

$ mn create-app bff --build maven --lang kotlin

Isso criará um projeto Micronaut executável usando Kotlin e Mavenem um diretório chamado bff. Abra este projeto na IDE que escolher e siga o passo 2 para configurar as dependências.

Micronaut >= 2.0

Caso queira adotar o Micronaut 2.0, pode usar o novo site de construção de projeto, semelhante ao do Spring.

Micronaut Launch com as configurações recomendadas para o iniciar o projeto do Beagle com o Micronaut

  • Essa configuração inicial utiliza:
    • Kotlin com Maven paraJava 8 (compatível com essa versão);
    • Junit como biblioteca de testes unitários.
  • Descompacte o arquivo na pasta que escolher para conter seu projeto BFF e abra o seu projeto na IDE de sua preferência.

Criando um microsserviço

Neste caso, usaremos o site do Spring para gerar um projeto com o microsserviço já criado:

Spring Initializer com as configurações recomendadas para o iniciar o projeto do Beagle com o Spring

  • Essa configuração inicial utiliza:
    • Kotlin com Maven;
    • A ultima versão do Spring Boot Actuator dependency;
    • Empacotamento JAR e Java 8 (compatível com essa versão).
  • Clique em GENERATE para fazer o download de um arquivo zip que contém o projeto Spring Boot.
  • Descompacte o arquivo na pasta que escolher para conter seu projeto BFF e abra o seu projeto na IDE de sua preferência.

Passo 2: Incluir requerimentos adicionais

Por último, você precisa complementar algumas configurações em nosso backend. Neste caso, o framework que você tiver escolhido é que irá definir como deve ser feita a implementação.

Clique na opção de Framework que você escolheu anteriormente e siga os passos para continuar a configuração.

Requerimentos adicionais:

  • Versão atual do Beagle: back

Configuração Maven

Para seguir com esse requerimento, adicione ao seu arquivo pom.xml a dependência abaixo.

<dependency>
	<groupId>br.com.zup.beagle</groupId>
	<artifactId>beagle-micronaut-starter</artifactId>
	<version>${beagle.version}</version>
</dependency>

Configuração Gradle

Para projetos configurados com Gradle, adicione a dependência do starter em seu arquivo build.gradle ou build.gradle.kts.

dependencies {
  implementation("br.com.zup.beagle:beagle-micronaut-starter:${beagle.version}")
}

Insira a versão de release do Beagle no lugar de ${beagle.version}. Ou seja, coloque a versão do Beagle destacada em azul da badge acima, mas sem o caracter v que antecede os números de versão.

Por exemplo: undefined-ext.beagle.version = "1.8.0"

Requerimentos adicionais:

  • Versão atual do Beagle: back

Configuração Maven

Para seguir com esse requerimento, adicione ao seu arquivo pom.xml a dependência abaixo.

<dependency>
	<groupId>br.com.zup.beagle</groupId>
	<artifactId>beagle-spring-starter</artifactId>
	<version>${beagle.version}</version>
</dependency>

Configuração Gradle

Para projetos configurados com Gradle, adicione a dependência do starter em seu arquivo build.gradle ou build.gradle.kts.

dependencies {
  implementation("br.com.zup.beagle:beagle-spring-starter:${beagle.version}")
}

Insira a versão de release do Beagle no lugar de ${beagle.version}. Ou seja, coloque a versão do Beagle destacada em azul da badge acima, mas sem o caracter v que antecede os números de versão.

Por exemplo:-ext.beagle.version = "1.5.1"

Parabéns, a configuração inicial está pronta para uso!

Você pode conferir um exemplo prático de tela ou componente Server-Driven para testar o BFF

Você pode conferir um exemplo prático de como testar o Beagle no Backend ou componente Server-Driven para testar o BFF.

Próximos Passos

Nesta seção, você fez a instalação inicial do Beagle na sua aplicação!
Para continuar a configurar o Beagle:

👉Vá para as configurações iniciais para habilitar uso do Beagle no seu projeto Backend

👉 Se quiser ir direto para prática, acesse nosso tutorial para criar um projeto do zero


Última modificação 09/06/2021: Documentation for Beagle React Native (#631) (7fc89746)