https://github.com/alivro/spring-boot-crud
Spring Boot CRUD REST API
https://github.com/alivro/spring-boot-crud
docker docker-compose h2-database hibernate java postman spring-data-jpa springboot
Last synced: 3 months ago
JSON representation
Spring Boot CRUD REST API
- Host: GitHub
- URL: https://github.com/alivro/spring-boot-crud
- Owner: alivro
- Created: 2024-11-21T03:53:50.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2025-02-07T18:01:34.000Z (about 1 year ago)
- Last Synced: 2025-03-28T04:37:12.672Z (12 months ago)
- Topics: docker, docker-compose, h2-database, hibernate, java, postman, spring-data-jpa, springboot
- Language: Java
- Homepage:
- Size: 145 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Spring Boot CRUD
## Índice
1. [Requisitos](#requisitos)
2. [Base de datos](#base-de-datos)
3. [Endpoints](#endpoints)
4. [Construcción y ejecución](#construcción-y-ejecución)
## Requisitos
Es necesario instalar y configurar las siguientes herramientas:
- [JDK 17](https://openjdk.org/)
- [Maven](https://maven.apache.org/)
- [Git](https://git-scm.com/)
- [Docker](https://www.docker.com/)
- [Docker Compose](https://docs.docker.com/compose/)
- [Postman](https://www.postman.com/)
## Base de datos
Este proyecto utiliza [H2](https://www.h2database.com/html/main.html) como gestor de base de datos, por lo que no es necesario realizar configuraciones adicionales para su uso.
## Endpoints
### Author
| Método | Endpoint | Descripción |
| ------ | ------------------- | --------------------------------------- |
| Get | /author/findAll | Busca todos los autores. |
| Get | /author/find/{id} | Busca un autor por ID. |
| Post | /author/save | Guarda un nuevo autor. |
| Put | /author/update/{id} | Actualiza un autor existente por su ID. |
| Delete | /author/delete/{id} | Elimina un autor por su ID. |
### Book
| Método | Endpoint | Descripción |
| ------ | ------------------- | ------------------------------------- |
| Get | /book/findAll | Busca todos los libros. |
| Get | /book/find/{id} | Busca un libro por ID. |
| Post | /book/save | Guarda un nuevo libro. |
| Put | /book/update/{id} | Actualiza un libro existente por su ID. |
| Delete | /book/delete/{id} | Elimina un libro por su ID. |
El directorio [*pm*](pm/) contiene las colecciones de Postman necesarias para probar el API.
## Construcción y ejecución
-
Clona el repositorio:
```
git@github.com:alivro/spring-boot-crud.git
```
-
Cambia al directorio raíz del proyecto:
```
cd spring-boot-crud/
```
-
Construye la aplicación:
```
mvn clean install
```
-
Construye la imágen de Docker:
```
docker-compose build
```
-
Ejecuta la aplicación con Docker Compose:
```
docker-compose up -d
```