@hestjs/scalar/dist/openapi-generator.d.ts

HestJS Scalar API Reference Integration - Beautiful API documentation for HestJS applications

import 'reflect-metadata';
import type { ControllerConstructor } from '@hestjs/core';
import type { OpenAPIV3 } from './decorators/openapi.decorators';
/**
 * OpenAPI 生成器配置
 */
export interface OpenAPIGeneratorConfig {
    /** 基础文档信息 */
    info: OpenAPIV3.InfoObject;
    /** 服务器配置 */
    servers?: OpenAPIV3.ServerObject[];
    /** 安全方案 */
    security?: OpenAPIV3.SecurityRequirementObject[];
    /** 全局标签 */
    tags?: OpenAPIV3.TagObject[];
    /** 外部文档 */
    externalDocs?: OpenAPIV3.ExternalDocumentationObject;
    /** 全局组件 */
    components?: OpenAPIV3.ComponentsObject;
}
/**
 * OpenAPI 文档生成器
 */
export declare class OpenAPIGenerator {
    private config;
    private paths;
    private components;
    constructor(config: OpenAPIGeneratorConfig);
    /**
     * 从控制器类生成 OpenAPI 路径
     */
    addController(controller: ControllerConstructor, basePath?: string): void;
    /**
     * 生成操作对象
     */
    private generateOperation;
    /**
     * 从类添加 Schema
     */
    private addSchemaFromClass;
    /**
     * 标准化路径
     */
    private normalizePath;
    /**
     * 拼接路径
     */
    private joinPaths;
    /**
     * 添加全局组件
     */
    addComponent(type: keyof OpenAPIV3.ComponentsObject, name: string, component: any): void;
    /**
     * 生成完整的 OpenAPI 文档
     */
    generateDocument(): OpenAPIV3;
    /**
     * 重置生成器
     */
    reset(): void;
}
//# sourceMappingURL=openapi-generator.d.ts.map