iGRPIGRP 3.0Documentation

Run Preview

Aprenda a executar e pré-visualizar a aplicação Spring Boot, configurar o banco de dados, testar endpoints e operações CRUD.

O processo de Execução e Pré-visualização seguem um fluxo definido, garantindo a correta geração de componentes essenciais antes do arranque da aplicação.

Objetivo

Objetivo

Executar a aplicação Spring Boot e pré-visualizar as funcionalidades implementadas, incluindo endpoints de controladores personalizados e operações CRUD automáticas.

Funcionalidades Testadas
  • Conectividade com banco de dados
  • Endpoints de controladores
  • Operações CRUD automáticas
  • Documentação da API
Validações Realizadas
  • Inicialização da aplicação
  • Acesso aos endpoints
  • Resposta das APIs
  • Monitoramento da aplicação

Fluxo de Execução

Passo 1Configuração do Banco de Dados

Configurar conexão com o banco de dados no application.properties

Passo 2Iniciar a Aplicação

Executar a aplicação Spring Boot

Passo 3Pré-visualização - Controladores

Aceder aos endpoints definidos nos controladores

Passo 4Pré-visualização - CRUD

Testar os métodos CRUD gerados automaticamente


Configuração do Banco de Dados

Editar application.properties

Configure a conexão com o banco de dados no arquivo application.properties:

# Database Configuration
spring.datasource.url=jdbc:postgresql://localhost:5432/minha_db
spring.datasource.username=postgres
spring.datasource.password=password
spring.datasource.driver-class-name=org.postgresql.Driver
# JPA Configuration
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.PostgreSQLDialect

Configuração Opcional

Se não desejar usar um banco de dados, comente ou remova a dependência spring-boot-starter-data-jpa no arquivo pom.xml.

Variáveis de Ambiente (.env)

Alternativamente, use variáveis de ambiente para maior segurança:

DB_HOST=localhost
DB_PORT=5432
DB_NAME=minha_db
DB_USERNAME=postgres
DB_PASSWORD=password

Iniciar a Aplicação

Executar Spring Boot

Execute a aplicação Spring Boot usando um dos comandos abaixo:

Via Maven

mvn spring-boot:run

Via IDE

Run main class

Verificar Inicialização

A aplicação estará disponível na URL base:

URL base da aplicação

Log de Inicialização

Verifique no console se a aplicação iniciou corretamente. Você deve ver mensagens indicando que o Tomcat está rodando na porta 8080 e que a aplicação foi iniciada com sucesso.

Pré-visualização - Controladores

Acesso aos Endpoints

Acesse os endpoints definidos nos controladores. Exemplo:

Endpoint de exemplo do controlador

Implementação Necessária

NOTA: Para aceder aos endpoints gerados, é necessário implementar os métodos declarados na interface do controlador. Esta implementação é realizada pelo programador.

Padrão de URL dos Controladores

Uma vez implementados os métodos declarados, os endpoints podem ser acedidos da seguinte forma:

http://<HOST>:<PORT>/<CONTROLLER_PATH>/<ACTION_PATH>

Pré-visualização - CRUD

Acesso aos Métodos CRUD

Para acessar os métodos CRUD, utilize a URL base do modelo. Exemplo:

URL base para CRUD do modelo Pessoa

CRUD Automático

IMPORTANTE: Quando o CRUD é gerado, para aceder aos métodos (GET, POST, DELETE, PUT) não é necessário implementar uma classe de controlador, acedemos simplesmente a: HOST:PORT/CRUD_PATH.

Métodos HTTP Disponíveis

MétodoDescrição
GETObter dados
POSTCriar novos registros
PUTAtualizar registros existentes
DELETERemover registros

Exemplos de Uso CRUD

GET    /pessoas    - Listar todas as pessoas
GET    /pessoas/1  - Obter pessoa com ID 1
POST   /pessoas    - Criar nova pessoa
PUT    /pessoas/1  - Atualizar pessoa com ID 1
DELETE /pessoas/1  - Excluir pessoa com ID 1

URLs de Pré-visualização

Links úteis para testar e monitorar a aplicação:


Ferramentas Recomendadas para Testes

Postman
Cliente REST para testar APIs
Insomnia
Cliente HTTP para testes de API
cURL
Ferramenta de linha de comando
Swagger UI
Interface web automática
Browser DevTools
Ferramentas do navegador
HTTPie
Cliente HTTP moderno
How is this guide?

Última atualização: