Desenvolvendo APIs em Java com Spring Boot: Um guia prático para iniciantes usando Postman e Docker

Introdução

Neste tutorial, vamos explorar o desenvolvimento de APIs em Java utilizando o framework Spring Boot. O Spring Boot simplifica o processo de criação de aplicações, permitindo uma configuração rápida e um desenvolvimento ágil. Vamos construir uma API RESTful desde o zero, passando por toda a estrutura necessária, desde a configuração do projeto até a implementação de testes unitários. Usaremos o Postman para testar os endpoints da API, facilitando a verificação de funcionalidades. Este guia é ideal para iniciantes que desejam aprender como criar APIs robustas e escaláveis com Java e Spring Boot, além de introduzir conceitos importantes de serviços e gerenciamento de dependências.

Etapas

Configuração do Ambiente de Desenvolvimento
Inicie garantindo que o Java Development Kit (JDK) e o Apache Maven estejam instalados. Verifique as versões instaladas utilizando os comandos a seguir antes de prosseguir.
commands
```
# Verificar versão do Java
java -version
# Verificar versão do Maven
mvn -version
```

Criação do Projeto Spring Boot

Utilize o Spring Initializr (https://start.spring.io/) para gerar um novo projeto. Escolha as opções: **Project**: Maven, **Language**: Java, **Spring Boot**: última versão estável, **Packaging**: Jar, **Java**: 11 ou superior. Adicione as dependências ‘Spring Web’, ‘Spring Data JPA’ e ‘H2 Database’. Baixe o projeto e descompacte-o em sua máquina local.

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.example</groupId>
  <artifactId>api-demo</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <name>api-demo</name>
  <description>Demo API with Spring Boot</description>
  <properties>
    <java.version>11</java.version>
  </properties>
  <dependencies>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-data-jpa</artifactId>
    </dependency>
    <dependency>
      <groupId>com.h2database</groupId>
      <artifactId>h2</artifactId>
      <scope>runtime</scope>
    </dependency>
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-test</artifactId>
      <scope>test</scope>
    </dependency>
  </dependencies>
  <build>
    <plugins>
      <plugin>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-maven-plugin</artifactId>
      </plugin>
    </plugins>
  </build>
</project>

Configuração do Banco de Dados H2

No arquivo `src/main/resources/application.properties`, configure as propriedades para o banco de dados H2, habilitando o console web do H2 para facilitar a visualização dos dados durante o desenvolvimento.

application.properties

spring.h2.console.enabled=true
spring.datasource.url=jdbc:h2:mem:testdb
spring.datasource.driverClassName=org.h2.Driver
spring.datasource.username=sa
spring.datasource.password=
spring.jpa.database-platform=org.hibernate.dialect.H2Dialect
spring.jpa.hibernate.ddl-auto=update

Criação da Entidade `Produto`

Implemente a classe modelo `Produto` que representará os produtos na aplicação. Use as anotações JPA para mapear a classe à tabela do banco de dados.

Produto.java

package com.example.apidemo.model;

import javax.persistence.*;

@Entity
@Table(name = "produtos")
public class Produto {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;

    @Column(nullable = false)
    private String nome;

    @Column(nullable = false)
    private Double preco;

    // Getters e Setters
    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getNome() {
        return nome;
    }

    public void setNome(String nome) {
        this.nome = nome;
    }

    public Double getPreco() {
        return preco;
    }

    public void setPreco(Double preco) {
        this.preco = preco;
    }
}

Criação do Repositório `ProdutoRepository`

Implemente a interface `ProdutoRepository`, que estende `JpaRepository`, permitindo acesso fácil aos métodos CRUD oferecidos pelo Spring Data JPA.

ProdutoRepository.java

package com.example.apidemo.repository;

import com.example.apidemo.model.Produto;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.stereotype.Repository;

@Repository
public interface ProdutoRepository extends JpaRepository<Produto, Long> {
    // Métodos personalizados podem ser definidos aqui
}

Implementação do Serviço `ProdutoService`

Crie a classe `ProdutoService`, que contém a lógica de negócios da aplicação e utiliza o `ProdutoRepository` para realizar operações no banco de dados.

ProdutoService.java

package com.example.apidemo.service;

import com.example.apidemo.model.Produto;
import com.example.apidemo.repository.ProdutoRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

import java.util.List;
import java.util.Optional;

@Service
public class ProdutoService {
    @Autowired
    private ProdutoRepository produtoRepository;

    public List<Produto> findAll() {
        return produtoRepository.findAll();
    }

    public Optional<Produto> findById(Long id) {
        return produtoRepository.findById(id);
    }

    public Produto save(Produto produto) {
        return produtoRepository.save(produto);
    }

    public Produto update(Long id, Produto produtoDetails) {
        Produto produto = produtoRepository.findById(id).orElseThrow(() -> new RuntimeException("Produto não encontrado"));
        produto.setNome(produtoDetails.getNome());
        produto.setPreco(produtoDetails.getPreco());
        return produtoRepository.save(produto);
    }

    public void deleteById(Long id) {
        produtoRepository.deleteById(id);
    }
}

Implementação do Controlador `ProdutoController`

Crie a classe `ProdutoController` que expõe os endpoints da API para permitir operações CRUD. Ele irá mapear as requisições HTTP para o serviço apropriado.

ProdutoController.java

package com.example.apidemo.controller;

import com.example.apidemo.model.Produto;
import com.example.apidemo.service.ProdutoService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/api/produtos")
public class ProdutoController {
    @Autowired
    private ProdutoService produtoService;

    @GetMapping
    public List<Produto> getAllProdutos() {
        return produtoService.findAll();
    }

    @GetMapping("/{id}")
    public ResponseEntity<Produto> getProdutoById(@PathVariable Long id) {
        return produtoService.findById(id)
                .map(ResponseEntity::ok)
                .orElse(ResponseEntity.notFound().build());
    }

    @PostMapping
    public Produto createProduto(@RequestBody Produto produto) {
        return produtoService.save(produto);
    }

    @PutMapping("/{id}")
    public ResponseEntity<Produto> updateProduto(@PathVariable Long id, @RequestBody Produto produtoDetails) {
        return ResponseEntity.ok(produtoService.update(id, produtoDetails));
    }

    @DeleteMapping("/{id}")
    public ResponseEntity<Void> deleteProduto(@PathVariable Long id) {
        produtoService.deleteById(id);
        return ResponseEntity.noContent().build();
    }
}

Implementação de Testes Unitários

Crie uma classe de teste chamada `ProdutoServiceTest` para validar a lógica de negócios da aplicação e verificar se as operações CRUD funcionam conforme esperado.

ProdutoServiceTest.java

package com.example.apidemo.service;

import com.example.apidemo.model.Produto;
import com.example.apidemo.repository.ProdutoRepository;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.MockitoAnnotations;

import java.util.Arrays;
import java.util.List;
import java.util.Optional;

import static org.junit.jupiter.api.Assertions.*;
import static org.mockito.Mockito.*;

public class ProdutoServiceTest {
    @InjectMocks
    private ProdutoService produtoService;

    @Mock
    private ProdutoRepository produtoRepository;

    @BeforeEach
    public void init() {
        MockitoAnnotations.openMocks(this);
    }

    @Test
    public void testFindAll() {
        Produto produto1 = new Produto();
        produto1.setId(1L);
        produto1.setNome("Produto 1");
        produto1.setPreco(10.0);

        Produto produto2 = new Produto();
        produto2.setId(2L);
        produto2.setNome("Produto 2");
        produto2.setPreco(20.0);

        when(produtoRepository.findAll()).thenReturn(Arrays.asList(produto1, produto2));

        List<Produto> produtos = produtoService.findAll();
        assertEquals(2, produtos.size());
        verify(produtoRepository, times(1)).findAll();
    }

    // Testes adicionais para os métodos findById, save, update e deleteById
}

Executando a Aplicação e Testes

Utilize o Maven para compilar e executar a aplicação. Após iniciar a aplicação, use o Postman ou cURL para interagir com os endpoints da API e verificar se tudo está funcionando corretamente.

commands

# Compilar e executar a aplicação
mvn spring-boot:run
# Executar os testes unitários
mvn test

curl_examples

# Listar todos os produtos
curl -X GET http://localhost:8080/api/produtos
# Criar um novo produto
curl -X POST -H "Content-Type: application/json" -d '{"nome":"Novo Produto", "preco":99.99}' http://localhost:8080/api/produtos

Conclusão

Neste tutorial, você aprendeu a desenvolver uma API RESTful utilizando Java com Spring Boot, com um foco claro na construção das camadas essenciais como modelo, repositório, serviço e controlador. Abordamos também como implementar testes unitários para garantir a qualidade do código, além de executar e testar endpoints usando o Postman. Com esses fundamentos, você pode agora expandir suas habilidades em desenvolvimento web e criar APIs mais complexas e adaptadas às necessidades do seu projeto.

Hashtags

#Java #SpringBoot #APIs #Postman #DesenvolvimentoDeSoftware

copycoda.com.br