next-rest-framework
Version:
Next REST Framework - write type-safe, self-documenting REST APIs in Next.js
60 lines (59 loc) • 1.54 kB
TypeScript
import { type NextRestFrameworkConfig } from '../types';
export declare const DEFAULT_CONFIG: {
openApiSpecOverrides: {
openapi: string;
info: {
title: string;
description: string;
version: any;
};
components: {};
};
openApiJsonPath: string;
openApiYamlPath: string;
swaggerUiPath: string;
deniedPaths: never[];
allowedPaths: string[];
swaggerUiConfig: {
defaultTheme: string;
title: string;
description: string;
faviconHref: string;
logoHref: string;
};
exposeOpenApiSpec: boolean;
errorHandler: ({ error }: {
error: unknown;
}) => void;
suppressInfo: boolean;
generatePathsTimeout: number;
};
export declare const getConfig: (config?: NextRestFrameworkConfig) => {
openApiSpecOverrides: {
openapi: string;
info: {
title: string;
description: string;
version: any;
};
components: {};
};
openApiJsonPath: string;
openApiYamlPath: string;
swaggerUiPath: string;
deniedPaths: never[];
allowedPaths: string[];
swaggerUiConfig: {
defaultTheme: string;
title: string;
description: string;
faviconHref: string;
logoHref: string;
};
exposeOpenApiSpec: boolean;
errorHandler: ({ error }: {
error: unknown;
}) => void;
suppressInfo: boolean;
generatePathsTimeout: number;
} & NextRestFrameworkConfig;