docs(README): añadida documentación del microservicio

parent f6508993
Showing with 84 additions and 0 deletions
# Microservicio para la conexión con la API de Gemini
## Descripción
Este microservicio en **Python + Flask** se encarga de realizar la conexión con la API de la IA Gemini para solicitar recetas de cocina.
Forma parte de un sistema donde el **backend en Spring Boot** consume este servicio y el **frontend web en Vue** expone los resultados al usuario.
## Archivos
- **app.py** : Clase principal de ejecución con la lógica de los endpoints y arranque del servidor.
- **asgi.py** : Archivo que expone la aplicación en formato ASGI para ejecución en producción con Uvicorn.
- **requirements.txt** : Dependencias necesarias para ejecutar el microservicio.
- **.env.example** : Archivo de configuración de ejemplo que muestra cómo debe definirse la variable de entorno con la API Key.
## Endpoints
- **POST `/recipe/search`** -> Devuelve 4 recetas iniciales según ingredientes indicados.
- **POST `/recipe/search/more`** -> Devuelve 4 recetas adicionales distintas a las anteriores.
- **POST `/recipe/detail/{index}`** -> Devuelve los detalles completos de una receta seleccionada.
## Requisitos previos
- **Python 3.10 o superior** instalado en el sistema.
- **pip** (incluido con Python a partir de la versión 3.4).
- Conexión a internet para acceder a la API de Gemini.
- Una **API Key de Gemini** válida (ver paso 4).
## Configuración y ejecución
### Paso 1 - Descargar el proyecto
Clonar el repositorio desde GitLab (acceso privado para tutor/examinadores):
```bash
git clone https://gitlab.ujaen.es/amaf0001/gemini-recipe-api.git
```
---
### Paso 2 - Crear el entorno virtual
- En **Windows**:
```bash
python -m venv venv
venv\Scripts\activate
```
- En **Linux/Mac**:
```bash
python3 -m venv venv
source venv/bin/activate
```
---
### Paso 3 - Instalar dependencias
Con el entorno virtual activado:
```bash
pip install -r requirements.txt
```
---
### Paso 4 - Obtener la clave de la API de Gemini
1. Acceder a [Google AI Studio](https://aistudio.google.com/).
2. Iniciar sesión con su cuenta de Google.
3. Crear una nueva API Key.
4. Crear un archivo **.env** (con este nombre exacto) en la raíz del proyecto, copiar el contenido de **.env.example** y reemplazar el valor.
---
### Paso 5 - Ejecutar el microservicio
- **Desarrollo**:
```bash
python app.py
```
Acceso en: http://localhost:5000
- **Producción** (recomendado):
```bash
uvicorn asgi:asgi_app --host 0.0.0.0 --port 5000
```
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment