tsoa-next / tsoa-next / SpecConfig

Interfaz: SpecConfig

Definido en: packages/runtime/src/config.ts:79

OpenAPI configuración de generación.

Propiedades

basePath?

optional basePath?: string;

Definido en: packages/runtime/src/config.ts:163

Base API path; por ejemplo, el 'v1' en https://myapi.com/v1

---

contact?

optional contact?: object;

Definido en: packages/runtime/src/config.ts:135

Información de contacto para la API publicada.

email?

optional email?: string;

La dirección de correo electrónico de la persona de contacto/organización.

Default

npm package author email

name?

optional name?: string;

El nombre de identificación de la persona de contacto/organización.

Default

npm package author

url?

optional url?: string;

URL señalando la información de contacto.

Default

npm package author url

---

description?

optional description?: string;

Definido en: packages/runtime/src/config.ts:124

Descripción de API; predeterminados a npm descripción del paquete

---

disableBasePathPrefixSlash?

optional disableBasePathPrefixSlash?: boolean;

Definido en: packages/runtime/src/config.ts:170

Controles si basePath está prefijado con / cuando se compone OpenAPI 3 URLs del servidor.

Solo disponible con la versión 3 o 3.1.

---

host?

optional host?: string;

Definido en: packages/runtime/src/config.ts:88

Nombre de host API Swagger 2 productos, por ejemplo localhost:3000.

---

license?

optional license?: string;

Definido en: packages/runtime/src/config.ts:158

Licencia API; predeterminados a npm licencia de paquete cuando presente

---

name?

optional name?: string;

Definido en: packages/runtime/src/config.ts:119

Nombre de API; predeterminados a npm nombre del paquete

---

operationIdTemplate?

optional operationIdTemplate?: string;

Definido en: packages/runtime/src/config.ts:197

Cadena de plantilla para generar ids de operación. Esta debe ser una plantilla de manillar válida y se proporciona con el siguiente contexto:

• 'controlador Nombre - Nombre de la clase de controlador.
• • Tsoa. Método objeto.

Default

'{{titleCase method.name}}'

---

outputDirectory

outputDirectory: string;

Definido en: packages/runtime/src/config.ts:83

Directorio donde se debe escribir el archivo de espectro generado.

---

rootSecurity?

optional rootSecurity?: Security[];

Definido en: packages/runtime/src/config.ts:232

Aplica una seguridad predeterminada a toda la API. Puede ser superado @Security(...) o @NoSecurity() decoradores en controladores o métodos.

---

schemes?

optional schemes?: Protocol[];

Definido en: packages/runtime/src/config.ts:215

Protocolos de apoyo para Swagger 2 salida.

---

securityDefinitions?

optional securityDefinitions?: object;

Definido en: packages/runtime/src/config.ts:202

Planes de seguridad declarados para la especificación.

Index Signature

[name: string]: SecuritySchemes

---

servers?

optional servers?: string[];

Definido en: packages/runtime/src/config.ts:95

URL de servidor para OpenAPI 3 salidas.

Solo disponible con la versión 3 o 3.1.

---

spec?

optional spec?: unknown;

Definido en: packages/runtime/src/config.ts:176

Objeto fusionado en la especie generada. Las propiedades generadas siempre tienen prioridad sobre los valores proporcionados aquí.

---

specFileBaseName?

optional specFileBaseName?: string;

Definido en: packages/runtime/src/config.ts:102

Base-nombre de intercambio. Json o Swagger. Yaml.

@default: "swagger"

---

specMerging?

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

Definido en: packages/runtime/src/config.ts:186

Controla cómo spec se fusiona en el documento generado. Valores posibles:

• "inmediato" anula sólo elementos de alto nivel.
• 'recursivo' realiza una fusión profunda usando merge.
• 'deepmerge' realiza una fusión profunda usando ts-deepmerge, incluyendo arrays.

Default

'immediate'

---

specVersion?

optional specVersion?: SupportedSpecMajorVersion;

Definido en: packages/runtime/src/config.ts:114

Major OpenAPI versión para generar; predeterminados a la versión 2 cuando no se especifica Valores posibles:

• 2: genera OpenAPI versión 2.
• 3: genera OpenAPI versión 3.
• 3.1: genera OpenAPI versión 3.1.

---

tags?

optional tags?: Tag[];

Definido en: packages/runtime/src/config.ts:209

Metadatos de etiquetas de alto nivel para la especificación generada.

---

termsOfService?

optional termsOfService?: string;

Definido en: packages/runtime/src/config.ts:130

Enlace a la página que describe los términos de servicio. Debe estar en el formato URL.

---

useTitleTagsForInlineObjects?

optional useTitleTagsForInlineObjects?: boolean;

Definido en: packages/runtime/src/config.ts:226

Añade títulos para la respuesta en línea y los esquemas de objeto de petición para mejorar la generación de clientes.

---

version?

optional version?: string;

Definido en: packages/runtime/src/config.ts:105

Número de versión API; predeterminado a la versión del paquete.

---

xEnumVarnames?

optional xEnumVarnames?: boolean;

Definido en: packages/runtime/src/config.ts:221

Soporte de x-enum-varnames

Default

false

---

yaml?

optional yaml?: boolean;

Definido en: packages/runtime/src/config.ts:212

Escribe la especificaciones generadas como YAML en lugar de JSON.

Contributors

No contributors

Changelog

No recent changes