api-morph / OpenAPIParser
Class: OpenAPIParser
Defined in: src/core/OpenAPIParser.ts:34
解析整个项目中的 JSDoc 注释,并生成 OpenAPI 对象
Constructors
Constructor
new OpenAPIParser(
project
,options
):OpenAPIParser
Defined in: src/core/OpenAPIParser.ts:42
Parameters
project
Project
options
ParserOptions
= {}
Returns
OpenAPIParser
Methods
parse()
parse(
openAPIBuilder
):Promise
<OpenAPIObject
>
Defined in: src/core/OpenAPIParser.ts:56
解析整个项目,返回完整的 OpenAPI 对象。
Parameters
openAPIBuilder
文档构建器实例。
Returns
Promise
<OpenAPIObject
>
返回完整的 OpenAPI 对象。