跳到内容

tsoa-next / tsoa-next / Swagger / Schema3

接口: Schema3

定义如下: packages/runtime/src/swagger/swagger.ts:399

扩展

  • Omit<BaseSchema, "additionalProperties" | "items" | "properties" | "type">

Indexable

ts
[key: `x-${string}`]: unknown

属性

$ref?

ts
optional $ref?: string;

定义如下: packages/runtime/src/swagger/swagger.ts:341

继承自

ts
Omit.$ref

additionalProperties?

ts
optional additionalProperties?: boolean | Schema3;

定义如下: packages/runtime/src/swagger/swagger.ts:402


allOf?

ts
optional allOf?: Schema3[];

定义如下: packages/runtime/src/swagger/swagger.ts:405


anyOf?

ts
optional anyOf?: Schema3[];

定义如下: packages/runtime/src/swagger/swagger.ts:404


default?

ts
optional default?: unknown;

定义如下: packages/runtime/src/swagger/swagger.ts:345

继承自

ts
Omit.default

deprecated?

ts
optional deprecated?: boolean;

定义如下: packages/runtime/src/swagger/swagger.ts:406


description?

ts
optional description?: string;

定义如下: packages/runtime/src/swagger/swagger.ts:343

继承自

ts
Omit.description

discriminator?

ts
optional discriminator?: string;

定义如下: packages/runtime/src/swagger/swagger.ts:365

继承自

ts
Omit.discriminator

enum?

ts
optional enum?: (string | number | boolean | null)[];

定义如下: packages/runtime/src/swagger/swagger.ts:357

继承自

ts
Omit.enum

example?

ts
optional example?: unknown;

定义如下: packages/runtime/src/swagger/swagger.ts:369

继承自

ts
Omit.example

exclusiveMaximum?

ts
optional exclusiveMaximum?: boolean;

定义如下: packages/runtime/src/swagger/swagger.ts:407


exclusiveMinimum?

ts
optional exclusiveMinimum?: boolean;

定义如下: packages/runtime/src/swagger/swagger.ts:408


externalDocs?

ts
optional externalDocs?: ExternalDocs;

定义如下: packages/runtime/src/swagger/swagger.ts:368

继承自

ts
Omit.externalDocs

format?

ts
optional format?: DataFormat;

定义如下: packages/runtime/src/swagger/swagger.ts:340

继承自

ts
Omit.format

items?

ts
optional items?: Schema3;

定义如下: packages/runtime/src/swagger/swagger.ts:403


maximum?

ts
optional maximum?: number;

定义如下: packages/runtime/src/swagger/swagger.ts:347

继承自

ts
Omit.maximum

maxItems?

ts
optional maxItems?: number;

定义如下: packages/runtime/src/swagger/swagger.ts:352

继承自

ts
Omit.maxItems

maxLength?

ts
optional maxLength?: number;

定义如下: packages/runtime/src/swagger/swagger.ts:349

继承自

ts
Omit.maxLength

maxProperties?

ts
optional maxProperties?: number;

定义如下: packages/runtime/src/swagger/swagger.ts:355

继承自

ts
Omit.maxProperties

minimum?

ts
optional minimum?: number;

定义如下: packages/runtime/src/swagger/swagger.ts:348

继承自

ts
Omit.minimum

minItems?

ts
optional minItems?: number;

定义如下: packages/runtime/src/swagger/swagger.ts:353

继承自

ts
Omit.minItems

minLength?

ts
optional minLength?: number;

定义如下: packages/runtime/src/swagger/swagger.ts:350

继承自

ts
Omit.minLength

minProperties?

ts
optional minProperties?: number;

定义如下: packages/runtime/src/swagger/swagger.ts:356

继承自

ts
Omit.minProperties

multipleOf?

ts
optional multipleOf?: number;

定义如下: packages/runtime/src/swagger/swagger.ts:346

继承自

ts
Omit.multipleOf

nullable?

ts
optional nullable?: boolean;

定义如下: packages/runtime/src/swagger/swagger.ts:401


pattern?

ts
optional pattern?: string;

定义如下: packages/runtime/src/swagger/swagger.ts:351

继承自

ts
Omit.pattern

properties?

ts
optional properties?: object;

定义如下: packages/runtime/src/swagger/swagger.ts:409

索引签名

ts
[propertyName: string]: Schema3

readOnly?

ts
optional readOnly?: boolean;

定义如下: packages/runtime/src/swagger/swagger.ts:366

继承自

ts
Omit.readOnly

required?

ts
optional required?: string[];

定义如下: packages/runtime/src/swagger/swagger.ts:370

继承自

ts
Omit.required

title?

ts
optional title?: string;

定义如下: packages/runtime/src/swagger/swagger.ts:342

继承自

ts
Omit.title

type?

ts
optional type?: DataType;

定义如下: packages/runtime/src/swagger/swagger.ts:400


uniqueItems?

ts
optional uniqueItems?: boolean;

定义如下: packages/runtime/src/swagger/swagger.ts:354

继承自

ts
Omit.uniqueItems

xml?

ts
optional xml?: XML;

定义如下: packages/runtime/src/swagger/swagger.ts:367

继承自

ts
Omit.xml

贡献者

暂无相关贡献者

页面历史

暂无最近变更历史

以 TypeScript 为先的 OpenAPI 生成、路由生成与运行时验证。