Class: ResponseBuilder

Defined in: src/builders/ResponseBuilder.ts:16

响应构建器，用于构建 OpenAPI ResponseObject

Implements

• Builder<ResponseObject>

Constructors

Constructor

new ResponseBuilder(): ResponseBuilder

Returns

ResponseBuilder

Methods

addContent()

addContent(mediaType: string, mediaTypeObject: MediaTypeObject): ResponseBuilder

Defined in: src/builders/ResponseBuilder.ts:62

添加响应的单个内容类型定义。

Parameters

mediaType

string

媒体类型 (例如 'application/json')。

mediaTypeObject

MediaTypeObject

媒体类型对象。

Returns

ResponseBuilder

响应构建器。

---

addExtension()

addExtension(key: `x-${string}`, value: unknown): ResponseBuilder

Defined in: src/builders/ResponseBuilder.ts:96

添加扩展字段。

Parameters

key

`x-${string}`

扩展字段键（必须以 'x-' 开头）。

value

unknown

扩展字段值。

Returns

ResponseBuilder

响应构建器。

---

addHeader()

addHeader(name: string, header: ReferenceObject | HeaderObject): ResponseBuilder

Defined in: src/builders/ResponseBuilder.ts:40

添加响应的单个头信息定义。头部名称会被转换为小写， 并且会过滤掉 content-type 头（OpenAPI 规范要求响应 headers 不应包含 "content-type"）。

Parameters

name

string

要设置的头信息的名称。

header

头对象或引用对象。

ReferenceObject | HeaderObject

Returns

ResponseBuilder

响应构建器。

---

addLink()

addLink(name: string, link: ReferenceObject | LinkObject): ResponseBuilder

Defined in: src/builders/ResponseBuilder.ts:79

添加响应的单个链接定义。

Parameters

name

string

要设置的链接的名称。

link

链接对象或引用对象。

ReferenceObject | LinkObject

Returns

ResponseBuilder

响应构建器。

---

build()

build(): ResponseObject

Defined in: src/builders/ResponseBuilder.ts:19

构建最终对象

Returns

ResponseObject

构建完成的对象

Implementation of

Builder.build

---

setDescription()

setDescription(description: string): ResponseBuilder

Defined in: src/builders/ResponseBuilder.ts:28

设置响应描述。

Parameters

description

string

响应描述。

Returns

ResponseBuilder

响应构建器。