ApiEntityBaseContract interface
Dettagli del contratto di base dell'API.
Proprietà
| api |
Descrive la revisione dell'API. Se non viene specificato alcun valore, viene creata la revisione predefinita 1 |
| api |
Descrizione della revisione DELL'API. |
| api |
Tipo di API. |
| api |
Indica l'identificatore della versione dell'API se l'API è con versione |
| api |
Descrizione della versione dell'API. |
| api |
Identificatore di risorsa per l'Oggetto ApiVersionSet correlato. |
| authentication |
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. |
| is |
Indica se la revisione dell'API è la revisione api corrente. |
| is |
Indica se la revisione dell'API è accessibile tramite il gateway. NOTA: questa proprietà non verrà serializzata. Può essere popolato solo dal server. |
| license | Informazioni sulla licenza per l'API. |
| subscription |
Protocolli su cui è disponibile l'API. |
| subscription |
Specifica se è necessaria una sottoscrizione api o prodotto per l'accesso all'API. |
| terms |
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 è con versione
apiVersion?: string
Valore della proprietà
string
apiVersionDescription
Descrizione della versione dell'API.
apiVersionDescription?: string
Valore della proprietà
string
apiVersionSetId
Identificatore di risorsa per l'Oggetto 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 api corrente.
isCurrent?: boolean
Valore della proprietà
boolean
isOnline
Indica se la revisione dell'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 prodotto 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