@omer-x/next-openapi-json-generator
Version:
a Next.js plugin to generate OpenAPI documentation from route handlers
19 lines (16 loc) • 922 B
TypeScript
import { OpenApiDocument } from '@omer-x/openapi-types';
import { ComponentsObject } from '@omer-x/openapi-types/components';
import { ZodType } from 'zod';
type GeneratorOptions = {
include?: string[];
exclude?: string[];
routeDefinerName?: string;
rootPath?: string;
info?: OpenApiDocument["info"];
servers?: OpenApiDocument["servers"];
security?: OpenApiDocument["security"];
securitySchemes?: ComponentsObject["securitySchemes"];
clearUnusedSchemas?: boolean;
};
declare function generateOpenApiSpec(schemas: Record<string, ZodType>, { include: includeOption, exclude: excludeOption, routeDefinerName, rootPath: additionalRootPath, info, servers, security, securitySchemes, clearUnusedSchemas: clearUnusedSchemasOption, }?: GeneratorOptions): Promise<Omit<OpenApiDocument, "components"> & Required<Pick<OpenApiDocument, "components">>>;
export { generateOpenApiSpec as default };