https://github.com/angelou20/civa-buses-api
API REST para gestionar buses y marcas, desarrollada en Spring Boot. Permite realizar operaciones CRUD con soporte de paginación y ordenamiento, y está documentada con Swagger. Ideal para sistemas de gestión de flotas o transporte.
https://github.com/angelou20/civa-buses-api
Last synced: about 2 months ago
JSON representation
API REST para gestionar buses y marcas, desarrollada en Spring Boot. Permite realizar operaciones CRUD con soporte de paginación y ordenamiento, y está documentada con Swagger. Ideal para sistemas de gestión de flotas o transporte.
- Host: GitHub
- URL: https://github.com/angelou20/civa-buses-api
- Owner: AngelOU20
- Created: 2024-11-14T23:28:55.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-15T00:56:16.000Z (over 1 year ago)
- Last Synced: 2025-03-20T20:16:21.282Z (about 1 year ago)
- Language: Java
- Size: 25.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Buses API
API para gestionar autobuses y marcas en una empresa de transporte.
## Tabla de Contenidos
- [Instalación](#instalación)
- [Configuración](#configuración)
- [Endpoints](#endpoints)
- [Modelo de Datos](#modelo-de-datos)
- [Documentación Swagger](#documentación-swagger)
## Instalación
1. Clona el repositorio:
```bash
git clone https://github.com/AngelOU20/civa-buses-api.git
```
2. Accede al proyecto:
```bash
cd busesapi
```
## Requisitos
- Java 17
- Spring Boot 3
- Maven
- MySQL 8
- IDE recomendado: IntelliJ
## Configuración
Edita application.properties con tu configuración de MySQL:
```bash
spring.datasource.url=jdbc:mysql://localhost:3306/tu-base-de-datos?useSSL=false
spring.datasource.username=tu-username
spring.datasource.password=tu-contraseña
```
## Estructura de la API
### EndPoints de Marcas
- `GET /api/v1/brands`: Obtener todas las marcas.
- `POST /api/v1/brands`: Crear una nueva marca.
- `DELETE /api/v1/brands/{id}`: Eliminar una marca por ID.
### EndPoints de Buses
- `POST /api/v1/bus`: Crear un nuevo autobús.
- `GET /api/v1/bus`: Obtener una lista paginada de autobuses.
- `GET /api/v1/bus/{id}`: Obtener un autobús por su ID.
- `PUT /api/v1/bus/{id}`: Actualizar los detalles de un autobús por ID.
- `DELETE /api/v1/bus/{id}`: Eliminar un autobús por ID.
## Documentación Swagger
Para acceder a la documentación completa de la API, dirígete a [http://localhost:8080/swagger-ui/index.html](http://localhost:8080/swagger-ui/index.html) después de iniciar la aplicación.