OpenAPIParser

reference

1 min readUpdated 2026-07-30

Kind: Class

Source: atloria-monorepo/libs/parser-core/src/parsers/api-schema/openapi.parser.ts

OpenAPI Parser Implementation (Parser-Core Version)

Supports:

Implements: IParser

Methods

Method	Signature	Returns
`initialize`	`initialize(_config: ParserConfig)`	`Promise<void>`
`canParse`	`canParse(filePath: string)`	`boolean`
`parseFile`	`parseFile(filePath: string, content: string)`	`Promise<ParseResult>`
`parseFiles`	`parseFiles(files: ParseFileInput[])`	`Promise<ParseResult[]>`
`destroy`	`destroy()`	`Promise<void>`

OpenAPIParser stops the work with an early return when !pathItem, in 4 places.
OpenAPIParser stops the work with an early return when !operation, in 4 places.
OpenAPIParser stops the work with an early return when !/\.(json|ya?ml)$/i.test(filePath).
OpenAPIParser stops the work with an early return when schema === null || typeof schema !== 'object'.
OpenAPIParser stops the work with an early return when ancestors.includes(schema as object).
OpenAPIParser stops the work with an early return when Array.isArray(schema).

OpenAPIParser handles failure in 2 places: it logs it and continues in 1, and turns it into a return value in 1.