ethanSanchezD / API-REST-zooHuitzil

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

zooHuitzil API-REST

Este proyecto es una Api-Rest de dos tablas provenientes de una base de datos hecha en PostGreSQL d
Explora el proyecto »

Ver Demo del proyecto · README-Template

Tabla de Contenidos
  1. Acerca del proyecto
  2. Manos a la obra
  3. Ejemplos de Uso
  4. Documentacion de la API

Acerca del Proyecto

Esta Api-Rest es un proyecto escolar cuyo proposito es implementar un CRUD de dos tablas provenientes de una base de datos realizada en PostGreSQL.

image

(back to top)

Hecho con

Java SpringBoot PostGreSQL Maven

(back to top)

Manos a la obra

Prerequisitos

Para correr este proyecto, es necesario:

Base de Datos

Este proyecto usa PostGreSQL como sistema manejador de bases de datos, además, para conectarse de manera exitosa a la base de datos, es necesaria la siguiente configuracion

  • Tener una base de datos llamada "zooHuitzil" de forma local en el puerto 5432, es decir, tener una base de datos en la siguiente ruta: localhost:5432/zooHuitzil
  • Nombre de usuario: postgres
  • Contraseña: 1234
  • El DDL y DML de la base de datos se encuentra en el proyecti rpincipal, en la siguiente ruta: proyecto principal

PostMan

Para hacer las pruebas de las rutas HTTP de la API-Rest, usamos PostMan como herramienta para realizarlas:

Proveemos de las peticiones HTTP que usamos en PostMan, para descargarlo, abre el link para:

Despues de descargar los archivos .json, al abrir la aplicación de PostMan, se pueden importar las colecciones de peticiones dandole click al boton de "Importar"

image
image

IDE Apache Neatbeans

Para la realizacion del proyecto se utilizó el IDE de APache Neatbeans, por lo que, para una mejor visualización y accesibilidad, es recomendable usar este IDE para correr la aplicacion

Instalacion

  1. Clona el repositorio
    git clone https://github.com/ethanSanchezD/API-REST-zooHuitzil.git

En ApacheNeatbeans:

  1. Abre el proyecto en el IDE

  2. Correr la clase principal Practica08TheQuerySquadApplication.java en la carpeta src/main/java/com/thequery_squad/Practica08_TheQuerySquad

(back to top)

Ejemplos de uso

En este proyecto se realizo el CRUD de dos tablas: Proveedor y Bioma sin embargo en cada tabla es posible hacer las operaciones:

  • Listar toda la informacion de la tabla
  • Obtener informacion de un dato en la tabla dado un id
  • Insertar un nuevo objeto a la tabla
  • Actualizar un objeto en la tabla
  • Eliminar un pbjeto de la tabla Algunos ejemplos:

Obtener toda la informacion de la tabla

2023-11-04.17-54-21.mp4

Obtener objeto dado su id

2023-11-04.17-55-49.mp4

Eliminar un objeto dado su id

2023-11-04.17-57-07.mp4

(back to top)

Documentacion de la API

Consideramos que es importante que al realizar una API-RESt, una buena práctica sería documentarla, es por eso que, mediante la herramienta de Swagger, se realizó esta tarea. Esta herramienta nos proporciona un interfaz gráfica en la que podemos observar cada método CRUD que se puede realizar. Para poder observar esta interfaz, es importante que se hayan seguido los pasos en Instalacion. Una vez realizado esos pasos, podemos visitar la siguiente direccion para poder visualizar la documentación de la API: Visualización

Al abrirlo, deberia aparecer una ventana como la que sigue: image

(back to top)

About


Languages

Language:Java 100.0%