arthurticianeli / ws-work-api

WS-Work-API

Este projeto é uma API desenvolvida com Spring Boot, projetada para gerenciar marcas e carros. Utiliza o PostgreSQL como banco de dados e Docker para facilitar o desenvolvimento e a implantação.

Pré-requisitos

• Java 11 ou superior
• Maven
• Docker e Docker Compose
• PostgreSQL (Opcional, se não quiser usar o Docker para o banco de dados)

Dependências do Projeto

• Spring Boot: Framework utilizado para criar a aplicação. Facilita a configuração e o desenvolvimento de aplicações baseadas em Spring.
• Spring Data JPA: Facilita a implementação de repositórios baseados em JPA para acesso a dados. Usado para interagir com o banco de dados.
• PostgreSQL Driver: Driver JDBC para o PostgreSQL. Necessário para conectar a aplicação ao banco de dados PostgreSQL.
• Lombok: Biblioteca que ajuda a reduzir o boilerplate em Java, fornecendo anotações para modelos de dados.
• Jakarta Persistence (JPA): Especificação para persistência de dados em Java. Usada para mapear objetos para o banco de dados.

Como Rodar o Projeto

1. Clone o repositório:

bash git clone https://github.com/arthurticianeli/ws-work-api.git

2. Navegue até o diretório do projeto:

bash cd ws-work-api

3. Construa a aplicação:

bash mvn clean install

4. Construa a imagem Docker da aplicação (opcional):

bash docker build -t arthurticianeli/ws-work-api:latest .

5. Inicie o banco de dados PostgreSQL com Docker Compose:

bash docker-compose up -d

Isso iniciará a aplicação e o banco de dados PostgreSQL. A aplicação estará acessível em http://localhost:8080.

Acessando a Aplicação

Após iniciar a aplicação, você pode acessar http://localhost:8080 para interagir com a API.

Documentação da API

Para mais detalhes sobre os endpoints disponíveis e como usá-los, consulte a documentação da API:

• Documentação da API