Skip to content

api-morph / SimplifiedResponseTagParser

Class: SimplifiedResponseTagParser

Defined in: src/parsers/SimplifiedResponseTagParser.ts:34

简化响应标签解析器,处理多种响应标签。

自动支持所有 HTTP 状态码的响应标签,例如:

  • @okResponse (200)
  • @createdResponse (201)
  • @noContentResponse (204)
  • @badRequestResponse (400)
  • @unauthorizedResponse (401)
  • @forbiddenResponse (403)
  • @notFoundResponse (404)
  • @conflictResponse (409)
  • @internalServerErrorResponse (500)
  • 以及所有其他 HTTP 状态码...

Extends

Constructors

Constructor

new SimplifiedResponseTagParser(context): SimplifiedResponseTagParser

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

创建标签解析器实例。

Parameters

context

ParseContext

解析上下文。

Returns

SimplifiedResponseTagParser

Inherited from

ResponseTagParser.constructor

Properties

context

context: ParseContext

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

解析上下文。

Inherited from

ResponseTagParser.context


tags

tags: string[]

Defined in: src/parsers/SimplifiedResponseTagParser.ts:35

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

Overrides

ResponseTagParser.tags

Methods

getTags()

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

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

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

Returns

(JSDocTagName | string & object)[]

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

Inherited from

ResponseTagParser.getTags


parse()

parse(tag): Promise<OperationData>

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

解析 JSDoc 标签。

Parameters

tag

JSDocTag

JSDoc 标签对象。

Returns

Promise<OperationData>

解析结果。

Inherited from

ResponseTagParser.parse

基于 MIT 许可证发布