api-morph / OperationBuilder

Class: OperationBuilder

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

操作构建器，用于构建 OpenAPI OperationObject

Implements

• Builder<OperationObject>

Constructors

Constructor

new OperationBuilder(): OperationBuilder

Returns

OperationBuilder

Methods

addCallback()

addCallback(name, callback): OperationBuilder

Defined in: src/builders/OperationBuilder.ts:182

添加回调。

Parameters

name

string

回调事件的名称 (event name)。

callback

回调对象或引用对象。

ReferenceObject | CallbackObject

Returns

OperationBuilder

操作构建器。

---

addExtension()

addExtension(key, value): OperationBuilder

Defined in: src/builders/OperationBuilder.ts:237

添加扩展字段。

Parameters

key

`x-${string}`

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

value

unknown

扩展字段值。

Returns

OperationBuilder

操作构建器。

---

addParameterFromBuilder()

addParameterFromBuilder(parameterBuilder): OperationBuilder

Defined in: src/builders/OperationBuilder.ts:127

使用 ParameterBuilder 添加参数。

Parameters

parameterBuilder

ParameterBuilder

参数构建器实例。

Returns

OperationBuilder

操作构建器。

---

addParameterFromObject()

addParameterFromObject(parameter): OperationBuilder

Defined in: src/builders/OperationBuilder.ts:88

添加参数（ParameterObject）。

Parameters

parameter

ParameterObject

参数对象（ParameterObject）。

Returns

OperationBuilder

操作构建器。

---

addParameterFromReference()

addParameterFromReference(parameter): OperationBuilder

Defined in: src/builders/OperationBuilder.ts:108

添加参数引用（ReferenceObject）。

Parameters

parameter

ReferenceObject

参数引用对象（ReferenceObject）。

Returns

OperationBuilder

操作构建器。

---

addResponse()

addResponse(statusCode, response): OperationBuilder

Defined in: src/builders/OperationBuilder.ts:158

添加响应。

Parameters

statusCode

string

HTTP 状态码。

response

响应对象。

ResponseObject | ReferenceObject

Returns

OperationBuilder

操作构建器。

---

addResponseFromBuilder()

addResponseFromBuilder(statusCode, responseBuilder): OperationBuilder

Defined in: src/builders/OperationBuilder.ts:171

使用 ResponseBuilder 添加响应。

Parameters

statusCode

string

responseBuilder

ResponseBuilder

响应构建器实例。

Returns

OperationBuilder

操作构建器。

---

addResponsesExtension()

addResponsesExtension(key, value): OperationBuilder

Defined in: src/builders/OperationBuilder.ts:251

添加响应扩展字段。

Parameters

key

`x-${string}`

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

value

unknown

扩展字段值。

Returns

OperationBuilder

操作构建器。

---

addSecurity()

addSecurity(securityRequirement): OperationBuilder

Defined in: src/builders/OperationBuilder.ts:208

添加此操作特定的安全要求。

Parameters

securityRequirement

SecurityRequirementObject

单个安全要求对象。

Returns

OperationBuilder

操作构建器。

---

addServer()

addServer(server): OperationBuilder

Defined in: src/builders/OperationBuilder.ts:222

添加此操作特定的服务器。

Parameters

server

ServerObject

服务器对象。

Returns

OperationBuilder

操作构建器。

---

addTag()

addTag(tag): OperationBuilder

Defined in: src/builders/OperationBuilder.ts:32

添加标签。

Parameters

tag

string

标签

Returns

OperationBuilder

操作构建器。

---

build()

build(): OperationObject

Defined in: src/builders/OperationBuilder.ts:23

构建最终对象

Returns

OperationObject

构建完成的对象

Implementation of

Builder.build

---

setDeprecated()

setDeprecated(deprecated): OperationBuilder

Defined in: src/builders/OperationBuilder.ts:198

设置已废弃标志。

Parameters

deprecated

boolean

是否已废弃。

Returns

OperationBuilder

操作构建器。

---

setDescription()

setDescription(description): OperationBuilder

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

设置操作描述。

Parameters

description

string

操作描述。

Returns

OperationBuilder

操作构建器。

---

setExternalDocs()

setExternalDocs(externalDocs): OperationBuilder

Defined in: src/builders/OperationBuilder.ts:68

设置外部文档。

Parameters

externalDocs

ExternalDocumentationObject

外部文档对象。

Returns

OperationBuilder

操作构建器。

---

setOperationId()

setOperationId(operationId): OperationBuilder

Defined in: src/builders/OperationBuilder.ts:78

设置操作 ID。

Parameters

operationId

string

操作 ID。

Returns

OperationBuilder

操作构建器。

---

setRequestBody()

setRequestBody(requestBody): OperationBuilder

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

设置请求体。

Parameters

requestBody

请求体对象。

ReferenceObject | RequestBodyObject

Returns

OperationBuilder

操作构建器。

---

setRequestBodyFromBuilder()

setRequestBodyFromBuilder(requestBodyBuilder): OperationBuilder

Defined in: src/builders/OperationBuilder.ts:147

使用 RequestBodyBuilder 设置请求体。

Parameters

requestBodyBuilder

RequestBodyBuilder

请求体构建器实例。

Returns

OperationBuilder

操作构建器。

---

setSummary()

setSummary(summary): OperationBuilder

Defined in: src/builders/OperationBuilder.ts:48

设置操作摘要。

Parameters

summary

string

操作摘要

Returns

OperationBuilder

操作构建器。