/challenge-back-end

Projeto desenvolvido durante a Alura Challenge Back-End. Desenvolvimento de API em java

Primary LanguageJava

logo

challenge-back-end API rest

Sobre • Requisitos • Tecnologias • Como Executar • Consumindo a API

💻 Sobre

O projeto consiste em desenvolver uma API Rest para se comunicar com o front-end desenvolvido em "React" onde o usuario pode adicionar, pesquisar e ver vídeos.
Projeto desenvolvido durante o Alura-Challanges-Back-End

👀 Requisitos

👨‍💻 Tecnologias

  • Linguagem Java
  • Banco de Dados Relacional Maria DB
  • Gerenciador de Dependências Maven
  • Framework Spring Boot
    • Spring Data JPA
    • Hibernate
    • JPA
    • Bean Validation
  • Testes JUnit
  • Geração de documentação e testes Postman

📖 Como Executar

>Projeto Compilado

  1. Baixe o arquivo API_alura_challenge-V1.jar dentro da pasta API-Alura-challenge-back-end.
  2. Crie um banco de dados, um usurio e uma senha no Mysql.
  3. Inicie o terminal(CMD) do windows.
  4. Navege até o diretório onde você salvou o arquivo API_alura_challenge-V1.jar.
  5. Execute o seguinte comando.

java -jar -Dspring.profiles.active=prod -DDB_NOME="valorAqui" -DDB_URL="valorAqui" -DDB_USUARIO="valorAqui" -DDB_SENHA="valorAqui" -DSERVER_PORT=valorAqui -DAPP_SENHA="valorAqui" -DDURACAO_TOKEN=valorAqui API_alura_challenge-V1.jar

Os valores marcados como valorAqui devem ser substituidos seguindo a seguinte tabela:

Valor Descrição
DDB_NOME nome do banco de dados utilizado pela api
DDB_URL url de acesso ao banco de dados
DDB_USUARIO usuario de acesso ao banco de dados
DDB_SENHA senha do usuario
DSERVER_PORT define a porta onde a aplicação irá rodar
DAPP_SENHA chave secreta para criação dos tokens de acesso
DDURACAO_TOKEN tempo de duração dos tokens de acesso. Esse valor deve ser passado em milissegundos. Ex: 3600000 = 1hora

O código final deve ser similar a este:

java -jar -Dspring.profiles.active=prod -DDB_NOME="api-alura" -DDB_URL="jdbc:mysql://localhost:3306/api-alura" -DDB_USUARIO="UserAPIAlura" -DDB_SENHA="S48wPdarFlnAWAOp3g" -DSERVER_PORT=8083 -DAPP_SENHA="qMNv8UJqLg6" -DDURACAO_TOKEN=86400000 API_alura_challenge-V1.jar

OBS: Quando o terminal for fechado a API ternimará sua execução.

>Execução pela IDE eclipse

  1. Copie o repositório para a sua máquina.
  2. Crie um banco de dados, um usurio e uma senha no Maria DB.
  3. Inicie a IDE do ecipse
  4. No menu superior clique em File > Import...
  5. Procure a opção "Existing Maven Projects" selecione está opção e clique em "Next".
  6. No canto soperior direito, clique em "Browse" navegue até a pasta do projeto, selecione a pasta do projeto e clique em "Selecionar pasta"
  7. Apos confirmar a pasta clique em "Next>"
  8. Com o projeto já importado vá até a pasta src/main/resources e abra o arquivo aplication.properties
  9. Altere os valores dos campos server.contextPath, spring.datasource.url, spring.datasource.username e spring.datasource.password para que corresponda ao seu banco de dados
  10. Vá até a classe ModeloApiApplication, clique com o botão direito do mouse nela e selecione "Run as" e clique em "Java Application"

🚀 Consumindo a API

A API está disponível em http://api-alura-challenge.meus-projetos.com/V1 conforma a documentação.
Documantação: https://documenter.getpostman.com/view/12149762/TzsZrTno
usuario e senha para autenticação
email: challengebackend@alura.com
senha: alura123