base_abp/PLAN_ORVAL.md

Plan para la Implementación de Orval

Este plan detalla los pasos para verificar y utilizar Orval como el generador de cliente de API para este proyecto.

1. Verificar la Configuración Existente

• Revisar package.json: Analizar el archivo en src/ASPBaseOIDC.Web.Ui para confirmar los scripts (generate:api) y las dependencias (orval).
• Examinar orval.config.js: Inspeccionar el archivo de configuración de Orval para comprender la configuración de generación, incluyendo rutas de salida, tipo de cliente (React Query, Axios, etc.) y otras opciones.

2. Generar el Cliente de API

• Prerrequisito: Asegurarse de que el servicio de backend (ASP.NET Core) se esté ejecutando, ya que es necesario para que el archivo swagger.json esté disponible en la URL especificada (normalmente localhost).
• Ejecutar el script: Navegar al directorio src/ASPBaseOIDC.Web.Ui y ejecutar el comando pnpm generate:api. Este comando primero descargará la especificación de OpenAPI y luego usará Orval para generar el cliente.

3. Integrar el Cliente Generado

• Verificar archivos: Comprobar que los archivos de TypeScript (tipos, cliente, etc.) se hayan generado en el directorio de salida especificado en la configuración.
• Proporcionar ejemplo de uso: Demostrar cómo importar y utilizar el cliente generado dentro de un componente de React (Next.js) para realizar una llamada a la API de forma segura y tipada.

4. Documentación y Limpieza

• Añadir a .gitignore: Asegurarse de que el directorio de salida de los archivos generados por Orval esté incluido en el archivo .gitignore para evitar que el código autogenerado se envíe al repositorio.
• Actualizar GEMINI.md: Agregar una sección en el archivo GEMINI.md que explique el flujo de trabajo para regenerar el cliente de la API, asegurando que el conocimiento se mantenga para futuras interacciones.