api-morph / ParameterBuilder

Class: ParameterBuilder

Defined in: src/builders/ParameterBuilder.ts:9

参数构建器，用于构建 OpenAPI ParameterObject

Implements

• Builder<ParameterObject>

Constructors

Constructor

new ParameterBuilder(name, paramIn): ParameterBuilder

Defined in: src/builders/ParameterBuilder.ts:17

创建 ParameterBuilder 实例。

Parameters

name

string

参数名称。

paramIn

ParameterIn

参数位置。

Returns

ParameterBuilder

Methods

addContent()

addContent(mediaType, mediaTypeObject): ParameterBuilder

Defined in: src/builders/ParameterBuilder.ts:151

添加参数的单个内容类型定义。

Parameters

mediaType

string

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

mediaTypeObject

MediaTypeObject

媒体类型对象。

Returns

ParameterBuilder

参数构建器。

---

addExtension()

addExtension(key, value): ParameterBuilder

Defined in: src/builders/ParameterBuilder.ts:168

添加扩展字段。

Parameters

key

`x-${string}`

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

value

unknown

扩展字段值。

Returns

ParameterBuilder

参数构建器。

---

build()

build(): ParameterObject

Defined in: src/builders/ParameterBuilder.ts:25

构建最终对象

Returns

ParameterObject

构建完成的对象

Implementation of

Builder.build

---

getIn()

getIn(): ParameterIn

Defined in: src/builders/ParameterBuilder.ts:41

获取参数位置。

Returns

ParameterIn

参数位置。

---

getName()

getName(): string

Defined in: src/builders/ParameterBuilder.ts:33

获取参数名称。

Returns

string

参数名称。

---

setAllowEmptyValue()

setAllowEmptyValue(allowEmptyValue): ParameterBuilder

Defined in: src/builders/ParameterBuilder.ts:80

设置是否允许空值。

Parameters

allowEmptyValue

boolean

是否允许空值。

Returns

ParameterBuilder

参数构建器。

---

setAllowReserved()

setAllowReserved(allowReserved): ParameterBuilder

Defined in: src/builders/ParameterBuilder.ts:110

设置是否允许保留字符。

Parameters

allowReserved

boolean

是否允许保留字符。

Returns

ParameterBuilder

参数构建器。

---

setDeprecated()

setDeprecated(deprecated): ParameterBuilder

Defined in: src/builders/ParameterBuilder.ts:70

设置参数是否已废弃。

Parameters

deprecated

boolean

是否已废弃。

Returns

ParameterBuilder

参数构建器。

---

setDescription()

setDescription(description): ParameterBuilder

Defined in: src/builders/ParameterBuilder.ts:50

设置参数描述。

Parameters

description

string

参数描述。

Returns

ParameterBuilder

参数构建器。

---

setExample()

setExample(example): ParameterBuilder

Defined in: src/builders/ParameterBuilder.ts:130

设置参数的单个示例。

Parameters

example

unknown

示例对象。

Returns

ParameterBuilder

参数构建器。

---

setExamples()

setExamples(examples): ParameterBuilder

Defined in: src/builders/ParameterBuilder.ts:140

设置参数的多个示例。

Parameters

examples

Record<string, ExampleObject | ReferenceObject>

示例对象。

Returns

ParameterBuilder

参数构建器。

---

setExplode()

setExplode(explode): ParameterBuilder

Defined in: src/builders/ParameterBuilder.ts:100

设置是否展开对象。

Parameters

explode

boolean

是否展开对象。

Returns

ParameterBuilder

参数构建器。

---

setRequired()

setRequired(required): ParameterBuilder

Defined in: src/builders/ParameterBuilder.ts:60

设置参数是否必需。

Parameters

required

boolean

是否必需。

Returns

ParameterBuilder

参数构建器。

---

setSchema()

setSchema(schema): ParameterBuilder

Defined in: src/builders/ParameterBuilder.ts:120

设置参数 Schema。

Parameters

schema

Schema 对象或引用对象。

undefined | boolean | SchemaObject

Returns

ParameterBuilder

参数构建器。

---

setStyle()

setStyle(style): ParameterBuilder

Defined in: src/builders/ParameterBuilder.ts:90

设置参数样式。

Parameters

style

参数样式。

undefined | ParameterStyle

Returns

ParameterBuilder

参数构建器。