ApiEntityBaseContract interface
Détails du contrat de base de l’API.
Propriétés
api |
Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision par défaut 1 est créée |
api |
Description de la révision de l’API. |
api |
Type d’API. |
api |
Indique l’identificateur de version de l’API si l’API est versionnée |
api |
Description de la version de l’API. |
api |
Identificateur de ressource pour l’ApiVersionSet associé. |
authentication |
Collection des paramètres d’authentification inclus dans cette API. |
contact | Coordonnées de l’API. |
description | Description de l’API. Peut comporter des balises de mise en forme. |
is |
Indique si la révision de l’API est la révision actuelle de l’API. |
is |
Indique si la révision de l’API est accessible via la passerelle. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur. |
license | Informations de licence pour l’API. |
subscription |
Protocoles sur lesquels l’API est mise à disposition. |
subscription |
Spécifie si un abonnement à l’API ou au produit est requis pour accéder à l’API. |
terms |
URL vers les conditions d’utilisation de l’API. DOIT être au format d’une URL. |
Détails de la propriété
apiRevision
Décrit la révision de l’API. Si aucune valeur n’est fournie, la révision par défaut 1 est créée
apiRevision?: string
Valeur de propriété
string
apiRevisionDescription
Description de la révision de l’API.
apiRevisionDescription?: string
Valeur de propriété
string
apiType
Type d’API.
apiType?: string
Valeur de propriété
string
apiVersion
Indique l’identificateur de version de l’API si l’API est versionnée
apiVersion?: string
Valeur de propriété
string
apiVersionDescription
Description de la version de l’API.
apiVersionDescription?: string
Valeur de propriété
string
apiVersionSetId
Identificateur de ressource pour l’ApiVersionSet associé.
apiVersionSetId?: string
Valeur de propriété
string
authenticationSettings
Collection des paramètres d’authentification inclus dans cette API.
authenticationSettings?: AuthenticationSettingsContract
Valeur de propriété
contact
description
Description de l’API. Peut comporter des balises de mise en forme.
description?: string
Valeur de propriété
string
isCurrent
Indique si la révision de l’API est la révision actuelle de l’API.
isCurrent?: boolean
Valeur de propriété
boolean
isOnline
Indique si la révision de l’API est accessible via la passerelle. REMARQUE : cette propriété ne sera pas sérialisée. Il ne peut être rempli que par le serveur.
isOnline?: boolean
Valeur de propriété
boolean
license
Informations de licence pour l’API.
license?: ApiLicenseInformation
Valeur de propriété
subscriptionKeyParameterNames
Protocoles sur lesquels l’API est mise à disposition.
subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract
Valeur de propriété
subscriptionRequired
Spécifie si un abonnement à l’API ou au produit est requis pour accéder à l’API.
subscriptionRequired?: boolean
Valeur de propriété
boolean
termsOfServiceUrl
URL vers les conditions d’utilisation de l’API. DOIT être au format d’une URL.
termsOfServiceUrl?: string
Valeur de propriété
string