@b8n/nestjs-rapidoc
Version:
NestJS module for RapiDoc
64 lines (63 loc) • 2.13 kB
TypeScript
export interface RapidocUIOptions {
specUrl?: never;
updateRoute?: boolean;
routePrefix?: string;
sortTags?: boolean;
sortEndpointsBy?: "path" | "method" | "summary" | "none";
headingText?: string;
gotoPath?: string;
fillRequestFieldsWithExample?: boolean;
persistAuth?: boolean;
theme?: "light" | "dark";
bgColor?: string;
textColor?: string;
headerColor?: string;
primaryColor?: string;
loadFonts?: boolean;
regularFont?: string;
monoFont?: string;
fontSize?: "default" | "large" | "largest";
cssFile?: string;
cssClasses?: string;
showMethodInNavBar?: false | "as-plain-text" | "as-colored-text" | "as-colored-block";
usePathInNavBar?: boolean;
navBgColor?: string;
navTextColor?: string;
navHoverBgColor?: string;
navHoverTextColor?: string;
navAccentColor?: string;
navAccentTextColor?: string;
navActiveItemMarker?: string;
navItemSpacing?: "default" | "compact" | "relaxed";
onNavTagClick?: "expand-collapse" | "show-description";
layout?: "row" | "column";
renderStyle?: "read" | "view" | "focused";
responseAreaHeight?: string;
showInfo?: boolean;
infoDescriptionHeadingsInNavbar?: boolean;
showComponents?: boolean;
showHeader?: boolean;
allowAuthentication?: boolean;
allowSpecUrlLoad?: boolean;
allowSpecFileLoad?: boolean;
allowSpecFileDownload?: boolean;
allowSearch?: boolean;
allowAdvancedSearch?: boolean;
allowTry?: boolean;
showCurlBeforeTry?: boolean;
allowServerSelection?: boolean;
allowSchemaDescriptionExpandToggle?: boolean;
schemaStyle?: "tree" | "table";
schemaExpandLevel?: number;
schemaDescriptionExpanded?: boolean;
schemaHideReadOnly?: "default" | "never";
schemaHideWriteOnly?: "default" | "never";
defaultSchemaTab?: "schema" | "example";
serverUrl?: string;
defaultApiServer?: string;
apiKeyName?: string;
apiKeyLocation?: "header" | "query";
apiKeyValue?: string;
fetchCredentials?: "omit" | "same-origin" | "include";
oauthReceiver?: string;
}