api-morph / ExternalDocsBuilder

Class: ExternalDocsBuilder

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

外部文档构建器，用于构建 OpenAPI ExternalDocumentationObject

Implements

• Builder<ExternalDocumentationObject>

Constructors

Constructor

new ExternalDocsBuilder(): ExternalDocsBuilder

Returns

ExternalDocsBuilder

Methods

addExtension()

addExtension(key, value): ExternalDocsBuilder

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

添加扩展字段。

Parameters

key

`x-${string}`

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

value

unknown

扩展字段值。

Returns

ExternalDocsBuilder

响应构建器。

---

build()

build(): ExternalDocumentationObject

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

构建最终对象

Returns

ExternalDocumentationObject

构建完成的对象

Implementation of

Builder.build

---

setDescription()

setDescription(description): ExternalDocsBuilder

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

设置外部文档描述。

Parameters

description

string

外部文档描述。

Returns

ExternalDocsBuilder

外部文档构建器。

---

setUrl()

setUrl(url): ExternalDocsBuilder

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

设置外部文档URL。

Parameters

url

string

外部文档URL（必需）。

Returns

ExternalDocsBuilder

外部文档构建器。