api-morph / ServerBuilder

Class: ServerBuilder

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

服务器构建器，用于构建 OpenAPI ServerObject

Implements

• Builder<ServerObject>

Constructors

Constructor

new ServerBuilder(): ServerBuilder

Returns

ServerBuilder

Methods

addExtension()

addExtension(key, value): ServerBuilder

Defined in: src/builders/ServerBuilder.ts:58

添加扩展字段。

Parameters

key

`x-${string}`

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

value

unknown

扩展字段值。

Returns

ServerBuilder

响应构建器。

---

addVariable()

addVariable(name, variable): ServerBuilder

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

添加服务器变量。

Parameters

name

string

变量名称。

variable

ServerVariableObject

服务器变量对象。

Returns

ServerBuilder

服务器构建器。

---

build()

build(): ServerObject

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

构建最终对象

Returns

ServerObject

构建完成的对象

Implementation of

Builder.build

---

setDescription()

setDescription(description): ServerBuilder

Defined in: src/builders/ServerBuilder.ts:30

设置服务器描述。

Parameters

description

string

服务器描述。

Returns

ServerBuilder

服务器构建器。

---

setUrl()

setUrl(url): ServerBuilder

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

设置服务器URL。

Parameters

url

string

服务器URL（必需）。

Returns

ServerBuilder

服务器构建器。