openapi-metadata/dist/ui/index.d.ts

Auto-Generate OpenAPI specifications from Typescript decorators

/**
 * Generates HTML to display Scalar UI.
 *
 * @see https://scalar.com/
 */
declare function generateScalarUI(url: string): string;

type GenerateSwaggerUIOptions = {
    persistAuthorization?: boolean;
};
/**
 * Generates HTML to display Swagger UI.
 *
 * @see https://swagger.io/tools/swagger-ui/
 */
declare function generateSwaggerUI(url: string, options?: GenerateSwaggerUIOptions): string;

/**
 * Generates HTML to display Rapidoc UI.
 *
 * @see https://rapidocweb.com/
 */
declare function generateRapidocUI(url: string): string;

export { generateRapidocUI, generateScalarUI, generateSwaggerUI };