Ir al contenido

Instalación SDK TypeScript

El SDK TypeScript de openUBL se publica como @openubl/sdk y se genera a partir de openapi.json. Proporciona clientes tipados y validación runtime con Zod para todos los endpoints de la API REST.

  • Node.js 18 o superior.
  • El servidor API de openUBL debe estar corriendo en la URL que uses (por defecto http://localhost:8000).
Ventana de terminal
npm install @openubl/sdk

Si estás modificando el SDK o quieres generarlo desde el repositorio:

Ventana de terminal
cd sdk/typescript
npm install
npm run generate
npm run build

Puedes comprobar la conexión con la API usando checkApiVersion:

import { checkApiVersion } from "@openubl/sdk";
const result = await checkApiVersion("http://localhost:8000");
console.log(result);