Skip to content
Toggle navigation
P
Projects
G
Groups
S
Snippets
Help
Alba María Álvarez
/
gemini-recipe-api
This project
Loading...
Sign in
Toggle navigation
Go to a project
Project
Repository
Issues
0
Merge Requests
0
Pipelines
Wiki
Snippets
Settings
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Commit
9c72953a
authored
Aug 16, 2025
by
Alba María Álvarez
Browse files
Options
_('Browse Files')
Download
Email Patches
Plain Diff
docs(README): añadida documentación del microservicio
parent
f6508993
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
84 additions
and
0 deletions
README.md
README.md
0 → 100644
View file @
9c72953a
# 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
\S
cripts
\a
ctivate
```
- 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
```
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment