tsoa-next / @tsoa-next/cli / ExtendedRoutesConfig

接口: 扩展路由配置

定义如下: cli/src/api.ts:416

正常路由生成配置返回 validateRoutesConfig。 。 。 。

扩展

• RoutesConfig

属性

authenticationModule?

optional authenticationModule?: string;

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

生成路由所使用的认证模块路径 。

继承自

RoutesConfig.authenticationModule

---

basePath?

optional basePath?: string;

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

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

继承自

RoutesConfig.basePath

---

bodyCoercion

bodyCoercion: boolean;

定义如下: cli/src/api.ts:419

是否隐含地强制身体参数为被接受的类型.

Default

true

覆盖

RoutesConfig.bodyCoercion

---

controllerPathGlobs?

optional controllerPathGlobs?: string[];

定义如下: cli/src/api.ts:420

---

entryFile

entryFile: string;

定义如下: cli/src/api.ts:417

---

esm?

optional esm?: boolean;

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

启用时, 生成的路由导入使用 .js 无害环境管理产出的扩展。

Default

false

继承自

RoutesConfig.esm

---

iocModule?

optional iocModule?: string;

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

例如 IoC 模块路径 ./inversify/ioc。 。 。 。

继承自

RoutesConfig.iocModule

---

middleware?

optional middleware?: "express" | "hapi" | "koa";

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

中相软件提供商.

继承自

RoutesConfig.middleware

---

middlewareTemplate?

optional middlewareTemplate?: string;

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

自定义 Handlebars 使用了模板路径,而不是内置的中间软件模板。

继承自

RoutesConfig.middlewareTemplate

---

multerOpts?

optional multerOpts?: Options;

定义如下: cli/src/api.ts:421

---

noImplicitAdditionalProperties

noImplicitAdditionalProperties: "ignore" | "throw-on-extras" | "silently-remove-extras";

定义如下: cli/src/api.ts:418

---

noWriteIfUnchanged?

optional noWriteIfUnchanged?: boolean;

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

当生成的内容与已有文件相匹配时跳过写入路由文件 。

继承自

RoutesConfig.noWriteIfUnchanged

---

rewriteRelativeImportExtensions?

optional rewriteRelativeImportExtensions?: boolean;

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

启用时, 生成的路由导入保留 .ts 扩展到支持 TypeScript 5.7 (中文(简体) ). rewriteRelativeImportExtensions。 。 。 。

Default

false

继承自

RoutesConfig.rewriteRelativeImportExtensions

---

rootSecurity?

optional rootSecurity?: Security[];

定义如下: cli/src/api.ts:422

---

routeGenerator?

optional routeGenerator?: 
  | string
  | ((metadata, options) => AbstractRouteGenerator<ExtendedRoutesConfig>);

定义如下: cli/src/api.ts:424

---

routesDir

routesDir: string;

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

生成的路由文件被写入目录 。

继承自

RoutesConfig.routesDir

---

routesFileName?

optional routesFileName?: string;

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

生成的路由模块的文件名 。

继承自

RoutesConfig.routesFileName

---

runtimeSpecConfig?

optional runtimeSpecConfig?: RuntimeSpecConfigSnapshot;

定义如下: cli/src/api.ts:423

贡献者

暂无相关贡献者

页面历史

暂无最近变更历史