bookstore-api-java

Santander Dev Week 2023 Java API

RESTful API da Santander Dev Week 2023 construída em Java 17 com Spring Boot 3.

Principais Tecnologias

• Java 17: Utilizaremos a versão LTS mais recente do Java para tirar vantagem das últimas inovações que essa linguagem robusta e amplamente utilizada oferece;
• Spring Boot 3: Trabalharemos com a mais nova versão do Spring Boot, que maximiza a produtividade do desenvolvedor por meio de sua poderosa premissa de autoconfiguração;
• Spring Data JPA: Exploraremos como essa ferramenta pode simplificar nossa camada de acesso aos dados, facilitando a integração com bancos de dados SQL;
• OpenAPI (Swagger): Vamos criar uma documentação de API eficaz e fácil de entender usando a OpenAPI (Swagger), perfeitamente alinhada com a alta produtividade que o Spring Boot oferece;
• Railway: facilita o deploy e monitoramento de nossas soluções na nuvem, além de oferecer diversos bancos de dados como serviço e pipelines de CI/CD.

Link do Figma

O Figma foi utilizado para a abstração do domínio desta API, sendo útil na análise e projeto da solução.

Diagrama de Classes (Domínio da API)

classDiagram
  class User {
    -String name
    -Account account
    -Feature[] features
    -Card card
    -News[] news
  }

  class Account {
    -String number
    -String agency
    -Number balance
    -Number limit
  }

  class Feature {
    -String icon
    -String description
  }

  class Card {
    -String number
    -Number limit
  }

  class News {
    -String icon
    -String description
  }

  User "1" *-- "1" Account
  User "1" *-- "N" Feature
  User "1" *-- "1" Card
  User "1" *-- "N" News

Loading

Documentação da API (Swagger)

https://sdw-2023-prd.up.railway.app/swagger-ui.html

Esta API ficará disponível no Railway por um período de tempo limitado, mas este é um código-fonte aberto. Portanto, sintam-se à vontade para cloná-lo, modificá-lo (já que é um bom projeto base para novos projetos) e executar localmente ou onde achar mais interessante! Só não esquece de marcar a gente quando divulgar a sua solução 🥰

IMPORTANTE

Aos interessados no desenvolvimento da tela inicial do App do Santander (Figma) em Angular, Android, iOS ou Flutter... Caso a URL produtiva não esteja mais disponível, deixamos um Backup no GitHub Pages, é só dar um GET lá 😘

• URL de Produção: https://sdw-2023-prd.up.railway.app/users/1
• Mock (Backup): https://digitalinnovationone.github.io/bookstore-api-java-api/mocks/find_one.json

EXECUTAR

Atualizar as dependências do projeto:

Para garantir que todas as dependências estão atualizadas e qualquer mudança no arquivo build.gradle seja aplicada, execute:

./gradlew.bat build

Esse comando irá compilar o projeto, rodar os testes, e preparar o projeto para ser executado. Ele verifica se há dependências que precisam ser baixadas ou atualizadas.

Limpar o projeto:

Se você quiser garantir que todas as compilações anteriores sejam removidas, você pode executar o comando clean antes de build:

./gradlew.bat clean
./gradlew.bat build

O comando clean remove todos os arquivos compilados previamente, permitindo uma compilação "limpa".

Depois de garantir que o projeto está atualizado e compilado corretamente, você pode executar:

./gradlew.bat bootRun

Esses passos ajudam a garantir que todas as dependências estão atualizadas e que o projeto é compilado a partir do zero, minimizando possíveis problemas de execução.