Documentación de la API REST con Flask

Descripción

Bienvenido a la documentación de esta API REST desarrollada con Flask. Esta API proporciona acceso a un catálogo de libros, incluyendo detalles como autor, género, año de publicación y resumen.

Índice

1. Instalación
2. Configuración
3. Uso
4. Rutas de la API
5. Ejemplos
6. Contribución
7. Licencia

Instalación

Para utilizar esta API en tu entorno local, sigue estos pasos:

1. Clona el repositorio desde GitHub:

   git clone https://github.com/PabloJRW/rest-api.git

2. Accede al directorio del proyecto:

   cd rest-api

3. Crea un entorno virtual (se recomienda el uso de venv):

   python -m venv venv

4. Activa el entorno virtual:

   En Windows:

   venv\Scripts\activate

   En macOS y Linux:

   source venv/bin/activate

5. Instala las dependencias:

   pip install -r requirements.txt

Configuración

Asegúrate de configurar las variables de entorno adecuadas y el archivo de configuración según sea necesario. Puedes encontrar ejemplos de configuración en el archivo config.py.

Uso

Para iniciar el servidor de desarrollo, ejecuta:

python run.py

La API estará disponible en http://localhost:5000/books.

Rutas de la API

A continuación, se describen las rutas principales de la API:

• GET /books: Obtiene una lista de todos los libros disponibles en la biblioteca.
• POST /books/add-book: Permite agregar un nuevo libro a la biblioteca.
• POST /books/add-books: Permite agregar una lista de libros a la biblioteca.
• PUT /books/edit/{id}: Actualiza la información de un libro existente.
• DELETE /books/delete/{id}: Elimina un libro de la biblioteca.
• GET /books/by-author/{author}: Busca libros por autor, proporcionando una lista de libros escritos por el autor especificado.
• GET /books/by-genre/{genre}: Filtra libros por género, devolviendo una lista de libros que pertenecen al género especificado.
• GET /books/search?q={query}: Realiza una búsqueda de libros utilizando una consulta de búsqueda proporcionada en el parámetro q.

Cada ruta tiene su propia funcionalidad y parámetros específicos. Consulta la documentación detallada de cada ruta para obtener más información sobre cómo utilizarlas.

Ejemplos

Puedes encontrar ejemplos de solicitud y respuesta en la carpeta examples.

Contribución

Aprecio las contribuciones! Si deseas mejorar este proyecto, sigue estos pasos:

1. Abre un issue para discutir tu propuesta de cambio.
2. Realiza un fork del repositorio.
3. Crea una rama para tu contribución: git checkout -b mi-contribucion.
4. Realiza los cambios y asegúrate de que las pruebas pasen.
5. Envía un pull request con tus cambios.

Licencia

Licencia

Este proyecto se distribuye como software no licenciado ("UNLICENSED"). Esto significa que no estás sujeto a ninguna licencia específica y tienes total libertad para utilizar, modificar y distribuir el código de acuerdo con tus propias necesidades. Ten en cuenta que el proyecto se proporciona tal como está y sin garantías.