tsoa-next / @tsoa-next/runtime / SpecConfig

接口: SpecConfig

定义如下: packages/runtime/src/config.ts:79

OpenAPI 生成设置。

属性

basePath?

optional basePath?: string;

定义如下: packages/runtime/src/config.ts:163

基础 API 路径; 例如“ v1” 以 https://myapi.com/v1

---

contact?

optional contact?: object;

定义如下: packages/runtime/src/config.ts:135

已公布的API的联系方式.

email?

optional email?: string;

联系人/组织的电子邮件地址。

Default

npm package author email

name?

optional name?: string;

联系人/组织的识别名称。

Default

npm package author

url?

optional url?: string;

URL指向联系信息.

Default

npm package author url

---

description?

optional description?: string;

定义如下: packages/runtime/src/config.ts:124

API 描述; 默认为 npm 软件包描述

---

disableBasePathPrefixSlash?

optional disableBasePathPrefixSlash?: boolean;

定义如下: packages/runtime/src/config.ts:170

是否控制 basePath 前缀为 / 编译时 OpenAPI 3个服务器 URL.

仅可用光谱版3或3.1.

---

host?

optional host?: string;

定义如下: packages/runtime/src/config.ts:88

API 主机名 Swagger 例如,2项产出 localhost:3000。 。 。 。

---

license?

optional license?: string;

定义如下: packages/runtime/src/config.ts:158

API 许可证; 默认为 npm 软件包许可证当存在时

---

name?

optional name?: string;

定义如下: packages/runtime/src/config.ts:119

API 名称; 默认为 npm 软件包名称

---

operationIdTemplate?

optional operationIdTemplate?: string;

定义如下: packages/runtime/src/config.ts:197

生成操作 ID 的模板字符串 。 这应该是一个有效的握手栏模板, 并已提供 内容如下:

• '控制器 名称' - 控制器类的字符串名称 。
• "方法" - 特苏亚. 方法对象.

Default

'{{titleCase method.name}}'

---

outputDirectory

outputDirectory: string;

定义如下: packages/runtime/src/config.ts:83

生成的光谱文件应当写入的目录 。

---

rootSecurity?

optional rootSecurity?: Security[];

定义如下: packages/runtime/src/config.ts:232

对整个API应用默认的担保. 能够被压倒 @Security(...) 或者说 @NoSecurity() 控制器或方法上的装饰器。

---

schemes?

optional schemes?: Protocol[];

定义如下: packages/runtime/src/config.ts:215

支持的协议 Swagger 2个产出。

---

securityDefinitions?

optional securityDefinitions?: object;

定义如下: packages/runtime/src/config.ts:202

为规格申报了安全计划。

索引签名

[name: string]: SecuritySchemes

---

servers?

optional servers?: string[];

定义如下: packages/runtime/src/config.ts:95

服务器 URL OpenAPI 3个产出。

仅可用光谱版3或3.1.

---

spec?

optional spec?: unknown;

定义如下: packages/runtime/src/config.ts:176

对象合并为生成的 spec 。 产生的属性总是优先于这里提供的值.

---

specFileBaseName?

optional specFileBaseName?: string;

定义如下: packages/runtime/src/config.ts:102

斯瓦克的底名 。 json还是swagger。 雅姆尔。

@ 默认 : “ swagger ”

---

specMerging?

optional specMerging?: "recursive" | "immediate" | "deepmerge";

定义如下: packages/runtime/src/config.ts:186

如何控制 spec 合并到生成的文档中。 可能的数值 :

• “ 立即” 仅覆盖顶级元素 。
• “ recursive” 使用 merge。 。 。 。
• “ 深度” 进行深度合并 ts-deepmerge,包括数组。

Default

'immediate'

---

specVersion?

optional specVersion?: SupportedSpecMajorVersion;

定义如下: packages/runtime/src/config.ts:114

主要 OpenAPI 要生成的版本; 未指定时默认为版本 2 可能的数值 :

• 2: 生成 OpenAPI 版本 2. 联合国
• 3: 生成 OpenAPI 版本 3个
• 3.1: 生成 OpenAPI 3.1版本。

---

tags?

optional tags?: Tag[];

定义如下: packages/runtime/src/config.ts:209

生成规格的顶级标签元数据 。

---

termsOfService?

optional termsOfService?: string;

定义如下: packages/runtime/src/config.ts:130

链接到描述服务条款的页面. 必须是 URL 格式 。

---

useTitleTagsForInlineObjects?

optional useTitleTagsForInlineObjects?: boolean;

定义如下: packages/runtime/src/config.ts:226

将标题添加到内置响应和请求-body对象计划来改进客户端生成.

---

version?

optional version?: string;

定义如下: packages/runtime/src/config.ts:105

API版本编号;默认为包版本.

---

xEnumVarnames?

optional xEnumVarnames?: boolean;

定义如下: packages/runtime/src/config.ts:221

启用 x- enum- varname 支持

Default

false

---

yaml?

optional yaml?: boolean;

定义如下: packages/runtime/src/config.ts:212

将生成的光谱写为 YAML 而不是 JSON 。

贡献者

暂无相关贡献者

页面历史

暂无最近变更历史