openapi-ts-mock-generator/dist/parsers/openapi-parser.d.ts

typescript mock data generator based openapi

import { OpenAPIV3_1 } from 'openapi-types';

/**
 * OpenAPI 문서 파싱 관련 유틸리티
 */

/**
 * OpenAPI 문서를 역참조(dereference)하여 로드
 * 모든 $ref를 실제 스키마로 해석하여 반환
 */
declare const getOpenAPIDocsDeref: (path: string) => Promise<OpenAPIV3_1.Document | undefined>;
/**
 * OpenAPI 문서를 번들(bundle)하여 로드
 * 외부 참조를 포함하여 하나의 문서로 통합
 */
declare const getOpenAPIDocsBundle: (path: string) => Promise<OpenAPIV3_1.Document | undefined>;
/**
 * OpenAPI 문서의 유효성을 검증
 */
declare const validateOpenAPIDoc: (path: string) => Promise<boolean>;
/**
 * OpenAPI 문서에서 스키마 컴포넌트 추출
 */
declare const extractSchemas: (doc: OpenAPIV3_1.Document) => Record<string, OpenAPIV3_1.SchemaObject>;
/**
 * OpenAPI 문서에서 경로 정보 추출
 */
declare const extractPaths: (doc: OpenAPIV3_1.Document) => OpenAPIV3_1.PathsObject;
/**
 * OpenAPI 버전 확인
 */
declare const getOpenAPIVersion: (doc: any) => string;

export { extractPaths, extractSchemas, getOpenAPIDocsBundle, getOpenAPIDocsDeref, getOpenAPIVersion, validateOpenAPIDoc };