api-morph / RequestBodyBuilder

Class: RequestBodyBuilder

Defined in: src/builders/RequestBodyBuilder.ts:8

请求体构建器，用于构建 OpenAPI RequestBodyObject

Implements

• Builder<RequestBodyObject>

Constructors

Constructor

new RequestBodyBuilder(): RequestBodyBuilder

Returns

RequestBodyBuilder

Methods

addContent()

addContent(mediaType, mediaTypeObject): RequestBodyBuilder

Defined in: src/builders/RequestBodyBuilder.ts:31

添加请求体的单个内容类型定义。

Parameters

mediaType

string

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

mediaTypeObject

MediaTypeObject

媒体类型对象。

Returns

RequestBodyBuilder

请求体构建器。

---

addExtension()

addExtension(key, value): RequestBodyBuilder

Defined in: src/builders/RequestBodyBuilder.ts:55

添加扩展字段。

Parameters

key

`x-${string}`

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

value

unknown

扩展字段值。

Returns

RequestBodyBuilder

请求体构建器。

---

build()

build(): RequestBodyObject

Defined in: src/builders/RequestBodyBuilder.ts:11

构建最终对象

Returns

RequestBodyObject

构建完成的对象

Implementation of

Builder.build

---

setDescription()

setDescription(description): RequestBodyBuilder

Defined in: src/builders/RequestBodyBuilder.ts:20

设置请求体描述。

Parameters

description

string

请求体描述。

Returns

RequestBodyBuilder

请求体构建器。

---

setRequired()

setRequired(required): RequestBodyBuilder

Defined in: src/builders/RequestBodyBuilder.ts:44

设置请求体是否必需。

Parameters

required

boolean

是否必需

Returns

RequestBodyBuilder

请求体构建器。