OpenApiOptions
interfaz
Opciones de generateOpenApi.
ts
import type { OpenApiOptions } from "@meekojs/meeko/server";Código fuente src/server/api/openapi.ts:27
Declaración #
ts
interface OpenApiOptions {
manifest: ServerManifest
info: { title: string; version: string }
publicSchemas: Readonly<Record<string, Schema>>
toJsonSchema(schema: Schema): unknown
load: ServerModuleLoader
cookieName?: string
}Ejemplo #
ts
import { pathToFileURL } from "node:url";
import { toJsonSchema } from "@valibot/to-json-schema";
import type { OpenApiOptions, Schema } from "@meekojs/meeko/server";
import * as schemas from "./shared/schemas/user.js";
const options: OpenApiOptions = {
manifest,
info: { title: "Mi API", version: "1.0.0" },
publicSchemas: schemas,
toJsonSchema: (schema: Schema) => toJsonSchema(schema as never),
load: (file) => import(pathToFileURL(file).href),
};Miembros #
publicSchemas
#
publicSchemas: Readonly<Record<string, Schema>>Registro de schemas públicos por nombre; sólo los que exporta shared/schemas.
toJsonSchema
#
toJsonSchema(schema: Schema): unknownConvierte un schema en JSON Schema; para Valibot, el conversor de @valibot/to-json-schema.
cookieName
#
cookieName?: stringNombre de la cookie de sesión del esquema de seguridad; por defecto, __Host-meeko.sid.