fumadocs-openapi
Version:
Generate MDX docs for your OpenAPI spec
33 lines (32 loc) • 1.1 kB
TypeScript
import { MediaAdapter } from "../../requests/media/adapter.js";
import { PlaygroundClientOptions } from "../../playground/client.js";
import { ExampleRequestItem } from "../operation/request-tabs.js";
import { FC } from "react";
//#region src/ui/client/index.d.ts
interface APIPageClientOptions {
playground?: PlaygroundClientOptions;
operation?: OperationClientOptions;
/**
* Set a prefix for `localStorage` keys.
*
* Useful when using multiple OpenAPI instances to prevent state conflicts.
*
* @defaultValue `fumadocs-openapi-`
*/
storageKeyPrefix?: string;
/**
* Support other media types (for client-side serialization)
*/
mediaAdapters?: Record<string, MediaAdapter>;
}
interface OperationClientOptions {
APIExampleSelector?: FC<{
items: ExampleRequestItem[];
value: string | undefined;
onValueChange: (id: string) => void;
}>;
}
declare function defineClientConfig(options?: APIPageClientOptions): APIPageClientOptions;
//#endregion
export { APIPageClientOptions, OperationClientOptions, defineClientConfig };
//# sourceMappingURL=index.d.ts.map