UNPKG

@scalar/nextjs-api-reference

Version:

a Next.js component to render API references from an OpenAPI file

19 lines (15 loc) 657 B
import { HtmlRenderingConfiguration } from '@scalar/core/libs/html-rendering'; /** * Next.js adapter for an Api Reference * * {@link https://github.com/scalar/scalar/tree/main/documentation/configuration.md Configuration} * * @params config - the Api Reference config object * @params options - reserved for future use to add customization to the response */ export declare const ApiReference: (givenConfiguration: Partial<ApiReferenceConfiguration>) => () => Promise<Response>; /** * The configuration for the Scalar API Reference for Next.js */ declare type ApiReferenceConfiguration = HtmlRenderingConfiguration; export { }