跳到内容

tsoa-next / tsoa-next / Tsoa / Parameter

接口:参数

定义如下: packages/runtime/src/metadataGeneration/tsoa.ts:74

属性

$ref?

ts
optional $ref?: BaseSchema<unknown>;

定义如下: packages/runtime/src/metadataGeneration/tsoa.ts:90


default?

ts
optional default?: unknown;

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


deprecated

ts
deprecated: boolean;

定义如下: packages/runtime/src/metadataGeneration/tsoa.ts:87


description?

ts
optional description?: string;

定义如下: packages/runtime/src/metadataGeneration/tsoa.ts:78


example?

ts
optional example?: Example[];

定义如下: packages/runtime/src/metadataGeneration/tsoa.ts:77


exampleLabels?

ts
optional exampleLabels?: (string | undefined)[];

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


externalValidator?

ts
optional externalValidator?: ExternalValidatorDescriptor;

定义如下: packages/runtime/src/metadataGeneration/tsoa.ts:86


in

ts
in: 
  | "request"
  | "body"
  | "path"
  | "query"
  | "header"
  | "res"
  | "formData"
  | "queries"
  | "body-prop"
  | "request-prop";

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


name

ts
name: string;

定义如下: packages/runtime/src/metadataGeneration/tsoa.ts:80


parameterIndex?

ts
optional parameterIndex?: number;

定义如下: packages/runtime/src/metadataGeneration/tsoa.ts:75


parameterName

ts
parameterName: string;

定义如下: packages/runtime/src/metadataGeneration/tsoa.ts:76


required?

ts
optional required?: boolean;

定义如下: packages/runtime/src/metadataGeneration/tsoa.ts:81


title?

ts
optional title?: string;

定义如下: packages/runtime/src/metadataGeneration/tsoa.ts:89


type

ts
type: Type;

定义如下: packages/runtime/src/metadataGeneration/tsoa.ts:82


validationStrategy?

ts
optional validationStrategy?: ValidationStrategy;

定义如下: packages/runtime/src/metadataGeneration/tsoa.ts:85


validators

ts
validators: Validators;

定义如下: packages/runtime/src/metadataGeneration/tsoa.ts:84

贡献者

暂无相关贡献者

页面历史

暂无最近变更历史

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