@yogeliu/mcp-server-yapi
Version:
Enhanced YAPI MCP server with multi-project support and enterprise features
54 lines • 1.57 kB
TypeScript
/**
* 单个项目配置接口
*/
export interface ProjectConfig {
/** YAPI服务器基础URL */
baseUrl: string;
/** YAPI访问令牌 */
token: string;
}
/**
* YAPI多项目配置接口定义
*/
export interface YapiConfig {
/** 项目配置映射:项目名 -> 项目配置 */
projects: Record<string, ProjectConfig>;
/** 默认项目名 */
defaultProject?: string;
}
/**
* 加载和验证配置
* @returns {YapiConfig} 验证后的配置对象
* @throws {Error} 当配置验证失败时抛出错误
*/
export declare function loadConfig(): YapiConfig;
/**
* 初始化配置(在应用启动时调用)
* @throws {Error} 当配置验证失败时抛出错误
*/
export declare function initializeConfig(): void;
/**
* 获取全局配置
* @returns {YapiConfig} 全局配置对象
* @throws {Error} 当配置未初始化时抛出错误
*/
export declare function getConfig(): YapiConfig;
/**
* 获取指定项目的配置
* @param projectName 项目名,如果不指定则使用默认项目
* @returns {ProjectConfig} 项目配置对象
* @throws {Error} 当项目不存在时抛出错误
*/
export declare function getProjectConfig(projectName?: string): ProjectConfig;
/**
* 获取所有可用项目名列表
* @returns {string[]} 项目名列表
*/
export declare function getAvailableProjects(): string[];
/**
* 验证配置有效性
* @param config 配置对象
* @returns true表示配置有效
*/
export declare function validateConfig(config: YapiConfig): boolean;
//# sourceMappingURL=config.d.ts.map