Interface: ParserOptions

Defined in: src/types/parser.ts:25

解析选项

Properties

customExpressCodeAnalyzers?

optional customExpressCodeAnalyzers: (context: ParseContext) => CodeAnalyzer[]

Defined in: src/types/parser.ts:43

自定义Expres代码分析器

Parameters

context

ParseContext

Returns

CodeAnalyzer

---

customFrameworkAnalyzers?

optional customFrameworkAnalyzers: (context: ParseContext) => FrameworkAnalyzer[]

Defined in: src/types/parser.ts:39

自定义框架分析器

Parameters

context

ParseContext

Returns

FrameworkAnalyzer

---

customHonoCodeAnalyzers?

optional customHonoCodeAnalyzers: (context: ParseContext) => CodeAnalyzer[]

Defined in: src/types/parser.ts:51

自定义Hono代码分析器

Parameters

context

ParseContext

Returns

CodeAnalyzer

---

customKoaCodeAnalyzers?

optional customKoaCodeAnalyzers: (context: ParseContext) => CodeAnalyzer[]

Defined in: src/types/parser.ts:47

自定义Koa代码分析器

Parameters

context

ParseContext

Returns

CodeAnalyzer

---

customTagParsers?

optional customTagParsers: (context: ParseContext) => TagParser[]

Defined in: src/types/parser.ts:35

自定义标签解析器

Parameters

context

ParseContext

Returns

TagParser

---

defaultRequestBodyMediaType?

optional defaultRequestBodyMediaType: string

Defined in: src/types/parser.ts:33

默认的请求体媒体类型

---

defaultResponseMediaType?

optional defaultResponseMediaType: string

Defined in: src/types/parser.ts:31

默认的响应媒体类型

---

enableCodeAnalysis?

optional enableCodeAnalysis: boolean

Defined in: src/types/parser.ts:58

是否启用代码分析

Default

true

---

exclude?

optional exclude: string[]

Defined in: src/types/parser.ts:29

要排除的文件模式

---

generateOperationId?

optional generateOperationId: GenerateOperationIdFunction

Defined in: src/types/parser.ts:63

自定义 operationId 生成函数，如果提供，将使用此函数生成 operationId。 返回 null 表示不生成 operationId。

---

include?

optional include: string[]

Defined in: src/types/parser.ts:27

要包含的文件模式