api-morph / MediaTypeBuilder

Class: MediaTypeBuilder

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

媒体类型构建器，用于构建 OpenAPI MediaTypeObject

Implements

• Builder<MediaTypeObject>

Constructors

Constructor

new MediaTypeBuilder(): MediaTypeBuilder

Returns

MediaTypeBuilder

Methods

addEncoding()

addEncoding(propertyName, encodingObject): MediaTypeBuilder

Defined in: src/builders/MediaTypeBuilder.ts:64

添加单个属性的编码信息。

Parameters

propertyName

string

属性名称。

encodingObject

EncodingObject

编码对象。

Returns

MediaTypeBuilder

媒体类型构建器。

---

addExtension()

addExtension(key, value): MediaTypeBuilder

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

添加扩展字段。

Parameters

key

`x-${string}`

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

value

unknown

扩展字段值。

Returns

MediaTypeBuilder

媒体类型构建器。

---

build()

build(): MediaTypeObject

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

构建最终对象

Returns

MediaTypeObject

构建完成的对象

Implementation of

Builder.build

---

setExample()

setExample(example): MediaTypeBuilder

Defined in: src/builders/MediaTypeBuilder.ts:43

设置媒体类型的单个示例。

Parameters

example

unknown

示例值。

Returns

MediaTypeBuilder

媒体类型构建器。

---

setExamples()

setExamples(examples): MediaTypeBuilder

Defined in: src/builders/MediaTypeBuilder.ts:53

设置媒体类型的多个示例。

Parameters

examples

Record<string, ExampleObject | ReferenceObject>

示例对象集合。

Returns

MediaTypeBuilder

媒体类型构建器。

---

setSchema()

setSchema(schema): MediaTypeBuilder

Defined in: src/builders/MediaTypeBuilder.ts:29

设置媒体类型的 Schema。

Parameters

schema

Schema 对象、布尔值或 Zod schema。

undefined | boolean | SchemaObject | ZodType<unknown, unknown, $ZodTypeInternals<unknown, unknown>>

Returns

MediaTypeBuilder

媒体类型构建器。