你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

SwaggerSchema interface

swagger 架构。

属性

additionalProperties

其他属性。

allOf

在使用此架构时必须通过验证的架构。

discriminator

歧视性。

dynamicListNew

动态列表。

dynamicSchemaNew

动态架构配置。

dynamicSchemaOld

动态架构配置。

dynamicTree

动态值树配置。

example

示例值。

externalDocs

外部文档。

items

项架构。

maxProperties

允许属性的最大数目。

minProperties

允许的最小属性数。

notificationUrlExtension

指示通知 URL 扩展。 如果已设置,则属性值应为 Webhook 的回调 URL。

properties

对象属性

readOnly

指示此属性是否必须存在于请求中。

ref

引用。

required

对象所需的属性。

title

标题。

type

类型

xml

属性的 xml 表示格式。

属性详细信息

additionalProperties

其他属性。

additionalProperties?: any

属性值

any

allOf

在使用此架构时必须通过验证的架构。

allOf?: SwaggerSchema[]

属性值

discriminator

歧视性。

discriminator?: string

属性值

string

dynamicListNew

动态列表。

dynamicListNew?: SwaggerCustomDynamicList

属性值

dynamicSchemaNew

动态架构配置。

dynamicSchemaNew?: SwaggerCustomDynamicProperties

属性值

dynamicSchemaOld

动态架构配置。

dynamicSchemaOld?: SwaggerCustomDynamicSchema

属性值

dynamicTree

动态值树配置。

dynamicTree?: SwaggerCustomDynamicTree

属性值

example

示例值。

example?: any

属性值

any

externalDocs

外部文档。

externalDocs?: SwaggerExternalDocumentation

属性值

items

项架构。

items?: SwaggerSchema

属性值

maxProperties

允许属性的最大数目。

maxProperties?: number

属性值

number

minProperties

允许的最小属性数。

minProperties?: number

属性值

number

notificationUrlExtension

指示通知 URL 扩展。 如果已设置,则属性值应为 Webhook 的回调 URL。

notificationUrlExtension?: boolean

属性值

boolean

properties

对象属性

properties?: {[propertyName: string]: SwaggerSchema}

属性值

{[propertyName: string]: SwaggerSchema}

readOnly

指示此属性是否必须存在于请求中。

readOnly?: boolean

属性值

boolean

ref

引用。

ref?: string

属性值

string

required

对象所需的属性。

required?: string[]

属性值

string[]

title

标题。

title?: string

属性值

string

type

类型

type?: string

属性值

string

xml

属性的 xml 表示格式。

xml?: SwaggerXml

属性值