api-morph / OpenAPIBuilder

Class: OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:34

文档构建器，用于构建完整的 OpenAPI 文档

Implements

• Builder<OpenAPIObject>

Constructors

Constructor

new OpenAPIBuilder(document?): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:37

Parameters

document?

Partial<Omit<OpenAPIObject, "info"> & object>

Returns

OpenAPIBuilder

Methods

addCallbackToComponents()

addCallbackToComponents(name, callback): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:456

添加回调组件到 components。

Parameters

name

string

回调名称。

callback

回调对象或引用对象。

ReferenceObject | CallbackObject

Returns

OpenAPIBuilder

文档构建器。

---

addComponentsExtension()

addComponentsExtension(key, value): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:496

添加组件扩展字段。

Parameters

key

`x-${string}`

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

value

unknown

扩展字段值。

Returns

OpenAPIBuilder

文档构建器。

---

addExampleToComponents()

addExampleToComponents(name, example): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:353

添加示例组件到 components。

Parameters

name

string

示例名称。

example

示例对象或引用对象。

ReferenceObject | ExampleObject

Returns

OpenAPIBuilder

文档构建器。

---

addExtension()

addExtension(key, value): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:275

添加扩展字段。

Parameters

key

`x-${string}`

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

value

unknown

扩展字段值。

Returns

OpenAPIBuilder

响应构建器。

---

addHeaderToComponents()

addHeaderToComponents(name, header): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:393

添加头部组件到 components。

Parameters

name

string

头部名称。

header

头部对象或引用对象。

ReferenceObject | HeaderObject

Returns

OpenAPIBuilder

文档构建器。

---

addInfoExtension()

addInfoExtension(key, value): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:136

添加 info 扩展字段。

Parameters

key

`x-${string}`

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

value

unknown

扩展字段值。

Returns

OpenAPIBuilder

文档构建器。

---

addLinkToComponents()

addLinkToComponents(name, link): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:436

添加链接组件到 components。

Parameters

name

string

链接名称。

link

链接对象或引用对象。

ReferenceObject | LinkObject

Returns

OpenAPIBuilder

文档构建器。

---

addParameterToComponents()

addParameterToComponents(name, parameter): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:333

添加参数组件到 components。

Parameters

name

string

参数名称。

parameter

参数对象或引用对象。

ReferenceObject | ParameterObject

Returns

OpenAPIBuilder

文档构建器。

---

addPathItem()

addPathItem(path, pathItem): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:174

添加路径项。

Parameters

path

string

API 路径。

pathItem

PathItemObject

路径项对象。

Returns

OpenAPIBuilder

文档构建器。

---

addPathItemFromBuilder()

addPathItemFromBuilder(path, pathItemBuilder): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:190

使用 PathItemBuilder 添加路径项。

Parameters

path

string

pathItemBuilder

PathItemBuilder

路径项构建器实例。

Returns

OpenAPIBuilder

文档构建器。

---

addPathItemToComponents()

addPathItemToComponents(name, pathItem): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:476

添加路径项组件到 components。

Parameters

name

string

路径项名称。

pathItem

PathItemObject

路径项对象或引用对象。

Returns

OpenAPIBuilder

文档构建器。

---

addPathsExtension()

addPathsExtension(key, value): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:201

添加 paths 扩展字段。

Parameters

key

`x-${string}`

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

value

unknown

扩展字段值。

Returns

OpenAPIBuilder

文档构建器。

---

addRequestBodyToComponents()

addRequestBodyToComponents(name, requestBody): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:373

添加请求体组件到 components。

Parameters

name

string

请求体名称。

requestBody

请求体对象或引用对象。

ReferenceObject | RequestBodyObject

Returns

OpenAPIBuilder

文档构建器。

---

addResponseToComponents()

addResponseToComponents(name, response): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:313

添加响应组件到 components。

Parameters

name

string

响应名称。

response

响应对象或引用对象。

ResponseObject | ReferenceObject

Returns

OpenAPIBuilder

文档构建器。

---

addSchemaToComponents()

addSchemaToComponents(name, schema): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:289

添加 Schema 组件到 components。

Parameters

name

string

Schema 名称。

schema

Schema 对象、布尔值或 Zod schema。

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

Returns

OpenAPIBuilder

文档构建器。

---

addSecurity()

addSecurity(securityRequirement): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:234

添加安全要求。

Parameters

securityRequirement

SecurityRequirementObject

单个安全要求对象。

Returns

OpenAPIBuilder

文档构建器。

---

addSecuritySchemeToComponents()

addSecuritySchemeToComponents(name, securityScheme): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:413

添加安全方案组件到 components。

Parameters

name

string

安全方案名称。

securityScheme

安全方案对象或引用对象。

ReferenceObject | SecuritySchemeObject

Returns

OpenAPIBuilder

文档构建器。

---

addServer()

addServer(server): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:159

添加服务器信息到文档中。

Parameters

server

ServerObject

要添加的服务器对象。

Returns

OpenAPIBuilder

文档构建器。

---

addTag()

addTag(tag): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:248

添加标签定义到文档中。

Parameters

tag

TagObject

要添加的标签对象。

Returns

OpenAPIBuilder

文档构建器。

---

addWebhook()

addWebhook(name, webhook): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:218

添加 Webhook。

Parameters

name

string

Webhook 名称。

webhook

PathItemObject

Webhook 的 PathItemObject。

Returns

OpenAPIBuilder

文档构建器。

---

build()

build(): OpenAPIObject

Defined in: src/builders/OpenAPIBuilder.ts:46

构建最终对象

Returns

OpenAPIObject

构建完成的对象

Implementation of

Builder.build

---

setContact()

setContact(contact): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:105

设置联系信息。

Parameters

contact

ContactObject

联系信息对象。

Returns

OpenAPIBuilder

文档构建器。

---

setDescription()

setDescription(description): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:85

设置 API 描述。

Parameters

description

string

API 描述。

Returns

OpenAPIBuilder

文档构建器。

---

setExternalDocs()

setExternalDocs(externalDocs): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:264

设置外部文档。

Parameters

externalDocs

ExternalDocumentationObject

外部文档对象。

Returns

OpenAPIBuilder

文档构建器。

---

setJsonSchemaDialect()

setJsonSchemaDialect(dialect): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:149

设置 JSON Schema Dialect。

Parameters

dialect

string

JSON Schema Dialect URI。

Returns

OpenAPIBuilder

文档构建器。

---

setLicense()

setLicense(license): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:115

设置许可证信息。

Parameters

license

LicenseObject

许可证信息对象。

Returns

OpenAPIBuilder

文档构建器。

---

setOpenAPIVersion()

setOpenAPIVersion(version): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:55

设置 OpenAPI 版本。

Parameters

version

OpenAPI 版本。

"3.1.0" | "3.1.1"

Returns

OpenAPIBuilder

文档构建器。

---

setSummary()

setSummary(summary): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:75

设置 API 摘要。

Parameters

summary

string

API 摘要。

Returns

OpenAPIBuilder

文档构建器。

---

setTermsOfService()

setTermsOfService(termsOfService): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:95

设置服务条款链接。

Parameters

termsOfService

string

服务条款链接。

Returns

OpenAPIBuilder

文档构建器。

---

setTitle()

setTitle(title): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:65

设置 API 标题。

Parameters

title

string

API 标题。

Returns

OpenAPIBuilder

文档构建器。

---

setVersion()

setVersion(version): OpenAPIBuilder

Defined in: src/builders/OpenAPIBuilder.ts:125

设置 API 版本。

Parameters

version

string

API 版本。

Returns

OpenAPIBuilder

文档构建器。