API REST desenvolvida com Spring para gerenciamento de usuários, com tratamento de exceções, documentação Swagger/OpenAPI e exemplos de boas práticas.
- Descrição
- Funcionalidades
- Tecnologias Utilizadas
- Como Executar
- Endpoints
- Tratamento de Erros
- Documentação Swagger
- Testes
- Autor
Este projeto é uma API RESTful para cadastro e gerenciamento de usuários, implementada em Java 21 com Spring Boot 3.3.0. O repositório de usuários é em memória (não utiliza banco de dados), ideal para fins didáticos e prototipagem.
- Cadastro de usuários com validação de dados.
- Listagem de todos os usuários.
- Busca de usuário por login ou ID.
- Atualização e remoção de usuários.
- Tratamento global de exceções.
- Documentação automática com Swagger/OpenAPI.
- Java 21
- Spring Boot 3.3.0
- Spring Web
- Spring Validation
- Springdoc OpenAPI (Swagger)
- JUnit 5 (testes)
- Maven
- Pré-requisitos: Java 21 e Maven instalados.
- Clone o repositório:
git clone https://github.com/krisnarane/web-api-rest-springboot cd web-api - Compile e execute:
mvn clean compile spring-boot:run
- Acesse a API em:
http://localhost:8080
GET /
Mensagem de boas-vindas.
-
GET /users
Lista todos os usuários. -
GET /users/{username}
Busca usuário pelo login. -
GET /users/id/{id}
Busca usuário pelo ID. -
POST /users
Cria um novo usuário.
Body:{ "login": "usuario", "password": "senha" } -
PUT /users
Atualiza um usuário existente. -
DELETE /users/{id}
Remove usuário pelo ID.
- Erros de negócio e validação retornam resposta padronizada:
{ "timestamp": "2025-08-05T12:00:00", "status": "error", "statusCode": 409, "error": "Mensagem de erro" }
Acesse a documentação interativa em:
http://localhost:8080/swagger-ui.html
ou
http://localhost:8080/swagger-ui/index.html
Os testes automatizados estão em src/test/java. Para rodar:
mvn test- Nome: Julia Krisnarane
- Email: jkrisnarane@gmail.com