Condividi tramite


ApiEntityBaseContract interface

Dettagli del contratto di base dell'API.

Proprietà

apiRevision

Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1

apiRevisionDescription

Descrizione della revisione DELL'API.

apiType

Tipo di API.

apiVersion

Indica l'identificatore della versione dell'API se l'API è in versione

apiVersionDescription

Descrizione della versione dell'API.

apiVersionSetId

Identificatore di risorsa per ApiVersionSet correlato.

authenticationSettings

Raccolta di impostazioni di autenticazione incluse in questa API.

contact

Informazioni di contatto per l'API.

description

Descrizione dell'API. Può includere tag di formattazione HTML.

isCurrent

Indica se la revisione dell'API è la revisione dell'API corrente.

isOnline

Indica se la revisione API è accessibile tramite il gateway. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

license

Informazioni sulla licenza per l'API.

subscriptionKeyParameterNames

Protocolli su cui è disponibile l'API.

subscriptionRequired

Specifica se è necessaria una sottoscrizione API o Product per l'accesso all'API.

termsOfServiceUrl

URL delle condizioni di servizio per l'API. DEVE essere nel formato di un URL.

Dettagli proprietà

apiRevision

Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1

apiRevision?: string

Valore della proprietà

string

apiRevisionDescription

Descrizione della revisione DELL'API.

apiRevisionDescription?: string

Valore della proprietà

string

apiType

Tipo di API.

apiType?: string

Valore della proprietà

string

apiVersion

Indica l'identificatore della versione dell'API se l'API è in versione

apiVersion?: string

Valore della proprietà

string

apiVersionDescription

Descrizione della versione dell'API.

apiVersionDescription?: string

Valore della proprietà

string

apiVersionSetId

Identificatore di risorsa per ApiVersionSet correlato.

apiVersionSetId?: string

Valore della proprietà

string

authenticationSettings

Raccolta di impostazioni di autenticazione incluse in questa API.

authenticationSettings?: AuthenticationSettingsContract

Valore della proprietà

contact

Informazioni di contatto per l'API.

contact?: ApiContactInformation

Valore della proprietà

description

Descrizione dell'API. Può includere tag di formattazione HTML.

description?: string

Valore della proprietà

string

isCurrent

Indica se la revisione dell'API è la revisione dell'API corrente.

isCurrent?: boolean

Valore della proprietà

boolean

isOnline

Indica se la revisione API è accessibile tramite il gateway. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server.

isOnline?: boolean

Valore della proprietà

boolean

license

Informazioni sulla licenza per l'API.

license?: ApiLicenseInformation

Valore della proprietà

subscriptionKeyParameterNames

Protocolli su cui è disponibile l'API.

subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract

Valore della proprietà

subscriptionRequired

Specifica se è necessaria una sottoscrizione API o Product per l'accesso all'API.

subscriptionRequired?: boolean

Valore della proprietà

boolean

termsOfServiceUrl

URL delle condizioni di servizio per l'API. DEVE essere nel formato di un URL.

termsOfServiceUrl?: string

Valore della proprietà

string