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

ApiOperationPropertiesDefinition interface

API作属性

属性

annotation

API作的注释。

api

API 参考。

description

API作的说明。

inputsDefinition

作输入定义架构。

isNotification

指示 API作是否通知。

isWebhook

指示 API作是否为 Webhook。

pageable

指示 API作是否可分页。

responsesDefinition

作响应定义架构。

summary

API作的摘要。

trigger

API作的触发器类型。

triggerHint

API作的触发器提示。

visibility

API作的可见性。

属性详细信息

annotation

API作的注释。

annotation?: ApiOperationAnnotation

属性值

api

API 参考。

api?: ApiReference

属性值

description

API作的说明。

description?: string

属性值

string

inputsDefinition

作输入定义架构。

inputsDefinition?: SwaggerSchema

属性值

isNotification

指示 API作是否通知。

isNotification?: boolean

属性值

boolean

isWebhook

指示 API作是否为 Webhook。

isWebhook?: boolean

属性值

boolean

pageable

指示 API作是否可分页。

pageable?: boolean

属性值

boolean

responsesDefinition

作响应定义架构。

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

属性值

{[propertyName: string]: SwaggerSchema}

summary

API作的摘要。

summary?: string

属性值

string

trigger

API作的触发器类型。

trigger?: string

属性值

string

triggerHint

API作的触发器提示。

triggerHint?: string

属性值

string

visibility

API作的可见性。

visibility?: string

属性值

string