Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/angel-raa/crud-spring-boot-postgresql
CRUD con Spring Boot 3 y postgresql
https://github.com/angel-raa/crud-spring-boot-postgresql
crud-api docker java jdk17 spring-boot spring-security
Last synced: about 2 months ago
JSON representation
CRUD con Spring Boot 3 y postgresql
- Host: GitHub
- URL: https://github.com/angel-raa/crud-spring-boot-postgresql
- Owner: Angel-Raa
- Created: 2023-08-12T01:40:09.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-09-08T14:19:45.000Z (over 1 year ago)
- Last Synced: 2024-04-16T10:58:46.430Z (9 months ago)
- Topics: crud-api, docker, java, jdk17, spring-boot, spring-security
- Language: Java
- Homepage:
- Size: 115 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# CRUD Básico con Spring Boot y PostgreSQL
Este proyecto es un ejemplo de una aplicación CRUD (Crear, Leer, Actualizar y Eliminar) básica desarrollada utilizando Java 17, Spring Boot 3 y PostgreSQL. La aplicación se encuentra en un entorno de contenedorizado utilizando Docker Compose.
## Tecnologías Utilizadas
- JDK 17
- Spring Boot 3
- Spring security 6
- PostgreSQL 15
- Java JWT
- Docker
## Configuración del Entorno
Asegúrate de tener instalados los siguientes componentes en tu entorno de desarrollo antes de comenzar:
1. [Docker](https://docs.docker.com/compose/install/)
## Instrucciones de Uso
Sigue estos pasos para ejecutar la aplicación en tu entorno local:
#### Clonar el repositorio en tu máquina local
```
git clone https://github.com/Angel-Raa/CRUD-spring-boot-postgresql.git
```
#### Navegar al directorio del proyecto
```
cd CRUD-spring-boot-postgresql
```
#### Construir y ejecutar los contenedores de Docker Compose
```
docker compose up -d
```
## Base URL
- [http://localhost:9000](http://localhost:9000)
Se requiere autenticación para acceder a los endpoints de esta API. Puedes obtener un token JWT mediante los siguientes endpoints:
| Método | Endpoint | Descripción |
|----------|----------------------------------------|--------------------------------------------|
| POST | `/authentication/login` | Iniciar sesión de usuario |
| POST | `/authentication/sign` | Registro de usuario |
## Autenticación
- **Iniciar sesión de usuario:** `POST /authentication/login`
- Cuerpo de la solicitud:
```json
{
"username": "angel",
"password": "admin"
}
```
- Respuesta exitosa:
```json
{
"jwt": "TOKEN_JWT"
}
```
- **Registro de usuario:** `POST /authentication/sign`
- Cuerpo de la solicitud:
```json
{
"username": "angel",
"password": "admin"
}
```
- Respuesta exitosa:
```json
{
"jwt": "TOKEN_JWT"
}
```
## Endpoints de Productos
| Método | Endpoint | Descripción |
|----------|----------------------------------------|--------------------------------------------|
| GET | `/product/list` | Obtener todos los productos |
| GET | `/product/{id}` | Obtener un solo producto |
| POST | `/product/add` | Guardar un nuevo producto |
| PUT | `/product/update/{id}` | Actualizar un producto existente |
| DELETE | `/product/{id}` | Eliminar un producto |
- **Obtener todos los productos:** `GET /product/list`
- Respuesta exitosa:
```json
[
{
"id": 1,
"name": "Papa gris",
"description": "papa gris",
"createAt": "2023-08-29T19:59:53.943202",
"amount": 1000,
"price": 25
},
{
"id": 2,
"name": "Arroz",
"description": "arroz blanco desde campo Rd",
"createAt": "2023-08-29T20:07:41.479372",
"amount": 1000,
"price": 25
}
// ...otros productos
]
```
- **Obtener un solo producto:** `GET /product/{id}`
- Parámetros:
- `{id}`: ID del producto a consultar
- Respuesta exitosa:
```json
{
"id": 1,
"name": "Papa gris",
"description": "papa gris",
"createAt": "2023-08-29T19:59:53.943202",
"amount": 1000,
"price": 25
}
```
- **Guardar un nuevo producto:** `POST /product/add`
- Cuerpo de la solicitud:
```json
{
"name": "Huevo gris",
"description": "Huevo de gallina gringa",
"amount": 1000,
"price": 10
}
```
- Respuesta exitosa:
```json
{
"id": 7,
"name": "Huevo gris",
"description": "Huevo de gallina gringa",
"createAt": "2023-08-30T00:56:09.430315",
"amount": 1000,
"price": 10
}
```
- **Actualizar un producto existente:** `PUT /product/update/{id}`
- Parámetros:
- `{id}`: ID del producto a actualizar
- Cuerpo de la solicitud:
```json
{
"name": "Huevo gris",
"description": "Huevo de gallina gringa",
"amount": 1000,
"price": 10
}
```
- Respuesta exitosa:
```json
{
"message": "Producto actualizado exitosamente."
}
```
- **Eliminar un producto:** `DELETE /product/{id}`
- Parámetros:
- `{id}`: ID del producto a eliminar
- Respuesta exitosa:
```json
{
"message": "Producto eliminado exitosamente.",
"code": 204,
"http": "NO_CONTENT"
}
```
Recuerda que debes incluir el token JWT en el encabezado de Autorización de cada solicitud a los endpoints protegidos.
## Recursos Adicionales
Aquí hay algunos recursos adicionales que podrían ser útiles:
- [Documentación de Java JWT](https://github.com/jwtk/jjwt)
- [Documentacion de open jdk 17](https://docs.oracle.com/en/java/javase/17/docs/api/)
- [Documentacion de Spring boot](https://docs.spring.io/spring-boot/docs/current/reference/htmlsingle/)
- [Documentacion de Maven](https://maven.apache.org/guides/getting-started/)
- [Documentacion de Docker](https://docs.docker.com/)
- [Documentacion de Spring Security](https://docs.spring.io/spring-security/reference/index.html)