@alexei2000/cms-openapi

Cliente TypeScript generado con OpenAPI Generator (typescript-axios) a partir del spec en spec/openapi.json. Está pensado para consumir la API del CMS desde Node o el navegador.

Requisitos

• axios es una peer dependency; debe instalarse en el proyecto que use este paquete.

Instalación

npm install @alexei2000/cms-openapi axios

Uso

Configura la URL base de la API y las credenciales que aplique tu spec (por ejemplo JWT):

import { Configuration, HealthApi } from "@alexei2000/cms-openapi";

const config = new Configuration({
  basePath: "https://tu-api.example.com",
  accessToken: "opcional-si-usas-bearer",
});

const health = new HealthApi(config);

const { data } = await health.healthControllerGet();

El paquete exporta las APIs generadas (AuthApi, ContentApi, HealthApi, MessagesApi, SettingsApi, UsersApi, etc.) y Configuration. Consulta los tipos en tu IDE o los archivos en dist/*.d.ts tras el build.

Desarrollo en este repositorio

| Script | Descripción | |--------|-------------| | npm run generate-sdk:docker | Genera el cliente con Docker (OpenAPI Generator CLI; no requiere Java en el host). | | npm run generate-sdk | Misma generación usando @openapitools/openapi-generator-cli instalado localmente o en el PATH. | | npm run build | Compila src/client a dist/ con TypeScript. |

Tras cambiar el spec o regenerar el cliente, ejecuta npm run build antes de publicar o de probar el paquete localmente.

Publicar en npm

npm login
npm version patch   # u otro nivel de versión
npm publish --access public

prepublishOnly ejecuta el build automáticamente al publicar.

Estructura

| Ruta | Contenido | |------|-----------| | spec/openapi.json | Documento OpenAPI de entrada | | openapi-generator-config.json | Opciones del generador (salida en src/client) | | src/client/ | Código generado (no editar a mano) | | dist/ | Salida compilada publicada en npm (generada por npm run build) |

Licencia

ISC