api-morph / RequestBodyTagParser

Class: RequestBodyTagParser

Defined in: src/parsers/RequestBodyTagParser.ts:18

请求体标签解析器，处理 @requestBody 标签。 支持简化语法: @requestBody [mediaType] [schema] [description]。

当省略 mediaType 但提供了 schema 时，会自动使用默认的请求体媒体类型。

Extends

• TagParser

Constructors

Constructor

new RequestBodyTagParser(context): RequestBodyTagParser

Defined in: src/core/TagParser.ts:24

创建标签解析器实例。

Parameters

context

ParseContext

解析上下文。

Returns

RequestBodyTagParser

Inherited from

TagParser.constructor

Properties

context

context: ParseContext

Defined in: src/core/TagParser.ts:24

解析上下文。

Inherited from

TagParser.context

---

tags

tags: string[]

Defined in: src/parsers/RequestBodyTagParser.ts:19

解析器支持的 JSDoc 标签名称列表

Overrides

TagParser.tags

Methods

getTags()

getTags(): (JSDocTagName | string & object)[]

Defined in: src/core/TagParser.ts:30

获取解析器支持的标签名称。

Returns

(JSDocTagName | string & object)[]

解析器支持的标签名称数组。

Inherited from

TagParser.getTags

---

parse()

parse(tag): Promise<OperationData>

Defined in: src/parsers/RequestBodyTagParser.ts:26

解析 JSDoc 标签。

Parameters

tag

JSDocTag

JSDoc 标签对象。

Returns

Promise<OperationData>

解析结果。

Overrides

TagParser.parse