api-morph / PathItemBuilder

Class: PathItemBuilder

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

路径项构建器，用于构建 OpenAPI PathItemObject

Implements

• Builder<PathItemObject>

Constructors

Constructor

new PathItemBuilder(): PathItemBuilder

Returns

PathItemBuilder

Methods

addExtension()

addExtension(key, value): PathItemBuilder

Defined in: src/builders/PathItemBuilder.ts:148

添加扩展字段。

Parameters

key

`x-${string}`

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

value

unknown

扩展字段值。

Returns

PathItemBuilder

操作构建器。

---

addOperation()

addOperation(method, operation): PathItemBuilder

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

添加操作。

Parameters

method

HttpMethod

HTTP 方法。

operation

OperationObject

操作对象。

Returns

PathItemBuilder

路径项构建器。

---

addOperationFromBuilder()

addOperationFromBuilder(method, operationBuilder): PathItemBuilder

Defined in: src/builders/PathItemBuilder.ts:74

使用 OperationBuilder 添加操作。

Parameters

method

HttpMethod

operationBuilder

OperationBuilder

操作构建器实例。

Returns

PathItemBuilder

路径项构建器。

---

addParameterFromBuilder()

addParameterFromBuilder(parameterBuilder): PathItemBuilder

Defined in: src/builders/PathItemBuilder.ts:137

使用 ParameterBuilder 添加参数。

Parameters

parameterBuilder

ParameterBuilder

参数构建器实例。

Returns

PathItemBuilder

操作构建器。

---

addParameterFromObject()

addParameterFromObject(parameter): PathItemBuilder

Defined in: src/builders/PathItemBuilder.ts:98

添加参数（ParameterObject）。

Parameters

parameter

ParameterObject

参数对象（ParameterObject）。

Returns

PathItemBuilder

操作构建器。

---

addParameterFromReference()

addParameterFromReference(parameter): PathItemBuilder

Defined in: src/builders/PathItemBuilder.ts:118

添加参数引用（ReferenceObject）。

Parameters

parameter

ReferenceObject

参数引用对象（ReferenceObject）。

Returns

PathItemBuilder

操作构建器。

---

addServer()

addServer(server): PathItemBuilder

Defined in: src/builders/PathItemBuilder.ts:84

添加服务器信息到路径项中。

Parameters

server

ServerObject

要添加的服务器对象。

Returns

PathItemBuilder

路径项构建器。

---

build()

build(): PathItemObject

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

构建最终对象

Returns

PathItemObject

构建完成的对象

Implementation of

Builder.build

---

setDescription()

setDescription(description): PathItemBuilder

Defined in: src/builders/PathItemBuilder.ts:49

设置路径描述。

Parameters

description

string

路径描述。

Returns

PathItemBuilder

路径项构建器。

---

setRef()

setRef(ref): PathItemBuilder

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

设置路径项的引用。

Parameters

ref

string

引用路径。

Returns

PathItemBuilder

路径项构建器。

---

setSummary()

setSummary(summary): PathItemBuilder

Defined in: src/builders/PathItemBuilder.ts:39

设置路径摘要。

Parameters

summary

string

路径摘要。

Returns

PathItemBuilder

路径项构建器。