Microsserviço AppArsenalName

Microserviço baseado na arquitetura Arsenal Cloud Native.

Esse projeto foi gerado automaticamente pelo arsenal-archetype-base.

Sumário

• Introdução
• Objetivo
• Evolução
• Instalação
• Pré-requisitos
• Configuração da Aplicação
  • Perfil default
  • Perfil local
• Utilização
• Compilação
• Execução da Aplicação
• Contratos de APIs
• Documentação
• Contribuições
• Equipe
• Licença

Introdução

TODO: descreva o contexto e histórico que motivaram a construção desse microsserviço.

Objetivo

TODO: descreva o objetivo e principais funcionalidades contempladas por esse microsserviço

Evolução

TODO: descreva as potenciais funcionalidades que ainda serão desenvolvidas nesse microsserviço

Instalação

Baixe o código-fonte desse repositório usando git clone ou de forma manual (.zip). Para prosseguir com a instação deste projeto é necessário atender a tabela de pré-requisitos com componentes na versão especificada ou superior.

Pré-requisitos

TODO: inclua as demais dependências e tecnologias do seu projeto (ex: Redis, Oracle, RabbitMQ, etc.)

Configuração da Aplicação

A aplicação foi planejada para ser executada em dois ambientes distintos compartilhando o máximo de similaridades possíveis. Para isso foram criados dois perfis (profiles). Detalhes das configurações, profiles e sua utilização estão na próxima seção.

Perfil default

Por padrão a aplicação está configurada para executar no ambiente de produção. Portanto, o profile default refere-se as configurações que serão utilizadas durante a operação real do sistema.

Perfil local

Um segundo profile local está definido e sobreescreve os valores de algumas configurações do profile default para que a aplicação execute corretamente no ambiente local do desenvolvedor.

Utilização

Abaixo seguem instruções de uso do projeto. Os comandos devem ser executados no terminal, ou diretamente na IDE de preferência do desenvolvedor.

Compilação

Para fazer o download de dependências e compilar o código-fonte da aplicação, navegue até o diretório raiz do projeto execute:

mvn clean package

Execução da Aplicação

Para executar a aplicação em modo de desenvolvimento, o profile local deve ser ativado explicitamente:

mvn spring-boot:run -Dspring-boot.run.profiles=local

A aplicação estará executando no endereço http://localhost:8080/

Também é possível simular uma execução do ambiente de produção no seu ambiente local. Para isso será necessário declarar explicitamente todas as variáveis de ambiente utilizadas pela aplicação.

Isso pode ser feito diretamente na sua IDE, ou pela linha de comando.

Abaixo um exemplo de como especificar as variáveis na linha de comando:

VARIAVEL_1=valor1 \
VARIAVEL_2=valor2 \
mvn spring-boot:run

Contratos de APIs

Este projeto utiliza a especificação OpenAPI para documentação e catálogo de APIs. Depois de executar a aplicação, é possível consultar todas operações fornecidas pelo serviço e testá-las respectivamente acessando o endereço http://localhost:8080/swagger-ui.html.

Documentação

TODO: adicione o link para o Confluence ou outra fonte de documentação do projeto.

Contribuições

Para reportar bugs, sugerir novas funcionalidades e melhorias entre em contato com alguns dos membros responsáveis por este projeto, ou submeta um Pull Request seguindo as práticas e convenções de desenvolvimento desse projeto.

TODO: inclua detalhes adicionais de como outras pessoas podem contribuir com esse projeto.

Equipe

Responsáveis pelo projeto:

Licença

Direitos reservados do Grupo Santander.