Introdução

Neste tutorial, vamos explorar a construção de APIs RESTful utilizando o framework Java Spring Boot. Esta abordagem é altamente recomendada para desenvolvedores que buscam eficiência e escalabilidade na criação de serviços web. A API RESTful é uma arquitetura que permite a comunicação entre diferentes sistemas, utilizando as operações HTTP (GET, POST, PUT, DELETE). Iremos abordar desde a configuração inicial do projeto até a implementação de testes automatizados, utilizando as melhores práticas em desenvolvimento de software. Ao final deste guia, você terá uma base sólida e um projeto completo que poderá utilizar como referência em projetos futuros.

Etapas

  1. Configuração do Ambiente de Desenvolvimento

    Antes de começarmos, é fundamental que você tenha o JDK (Java Development Kit) e o Maven instalados. Verifique suas versões com os comandos `java -version` e `mvn -version`. Se ainda não tiver, instale-os através dos sites oficiais.

    commands
    # Verifique se o JDK e o Maven estão instalados
    java -version
    mvn -version

  2. Criação do Projeto Spring Boot

    Utilize o Spring Initializr (https://start.spring.io/) para gerar um novo projeto com Maven. Selecione as dependências: Spring Web, Spring Data JPA e H2 Database. Baixe o projeto e descompacte-o em seu ambiente de trabalho.

    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-restful</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  <name>api-restful</name>
  <description>API RESTful com 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>

  3. Configuração do Banco de Dados H2

    Modifique o arquivo `application.properties` para configurar o banco de dados H2. Isto incluirá a habilitação do console web para visualização de 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

  4. Criação da Entidade `Produto`

    Crie uma classe modelo `Produto` que representará os produtos em nossa aplicação. Utilize anotações JPA para mapear a classe à tabela do banco de dados.

    Produto.java
    package com.example.apirestful.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;
    }
}

  5. Criação do Repositório `ProdutoRepository`

    Implemente a interface `ProdutoRepository`, que estende `JpaRepository` para fornecer métodos de acesso e manipulação dos dados.

    ProdutoRepository.java
    package com.example.apirestful.repository;

import com.example.apirestful.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
}

  6. Implementação do Serviço `ProdutoService`

    Crie a classe `ProdutoService`, que contém a lógica de negócios e utiliza o `ProdutoRepository` para interagir com os dados do banco de dados.

    ProdutoService.java
    package com.example.apirestful.service;

import com.example.apirestful.model.Produto;
import com.example.apirestful.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);
    }
}

  7. Implementação do Controlador `ProdutoController`

    Crie a classe `ProdutoController` para expor os endpoints da API, permitindo operações CRUD.

    ProdutoController.java
    package com.example.apirestful.controller;

import com.example.apirestful.model.Produto;
import com.example.apirestful.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();
    }
}

  8. Implementação de Testes Unitários

    Crie a classe de testes `ProdutoServiceTest` para validar a lógica de negócios e operações CRUD da aplicação.

    ProdutoServiceTest.java
    package com.example.apirestful.service;

import com.example.apirestful.model.Produto;
import com.example.apirestful.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 para os métodos findById, save, update e deleteById
}

  9. Executando a Aplicação e Testes

    Use o Maven para compilar e executar sua aplicação. Utilize o Postman ou cURL para testar os endpoints da API.

    commands
    # Compile e execute a aplicação
    mvn spring-boot:run
    # Execute 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 construir uma API RESTful utilizando Spring Boot de uma maneira prática e escalável. Desde a configuração inicial do projeto até a implementação de testes unitários, todas as etapas foram cobertas. Agora, você tem uma base sólida para expandir suas habilidades em Java e desenvolvimento de APIs, permitindo que você crie aplicações mais complexas e robustas. Com o conhecimento adquirido, você está pronto para explorar ainda mais as possibilidades que o Spring Boot e Java têm a oferecer.

Hashtags

#Java #SpringBoot #APIs #DesenvolvimentoDeSoftware #JUnit #TesteUnitário