Partager via


ApiResourceVersion interface

Représente les informations de version d’une ressource API REST

Propriétés

apiVersion

Représentation sous forme de chaîne de la version de l’API publique. Il s’agit de la version que le public voit et est utilisée pour un grand groupe de services (par exemple, l’API TFS 1.0)

isPreview

Version de l’API publique en préversion

resourceVersion

Version de ressource interne. Cela est défini par ressource et est utilisé pour prendre en charge la compatibilité de build à build des modifications d’API au sein d’une version d’API publique donnée (en préversion). Par exemple, dans le cycle de publication de l’API TFS 1.0, alors qu’elle est toujours en préversion, la structure de données d’une ressource peut être modifiée. Cette ressource peut être versionnée de sorte que les clients plus anciens fonctionnent toujours (les demandes seront envoyées à l’ancienne version) et que les clients nouveaux/mis à niveau communiquent avec la nouvelle version de la ressource.

Détails de la propriété

apiVersion

Représentation sous forme de chaîne de la version de l’API publique. Il s’agit de la version que le public voit et est utilisée pour un grand groupe de services (par exemple, l’API TFS 1.0)

apiVersion: string

Valeur de propriété

string

isPreview

Version de l’API publique en préversion

isPreview: boolean

Valeur de propriété

boolean

resourceVersion

Version de ressource interne. Cela est défini par ressource et est utilisé pour prendre en charge la compatibilité de build à build des modifications d’API au sein d’une version d’API publique donnée (en préversion). Par exemple, dans le cycle de publication de l’API TFS 1.0, alors qu’elle est toujours en préversion, la structure de données d’une ressource peut être modifiée. Cette ressource peut être versionnée de sorte que les clients plus anciens fonctionnent toujours (les demandes seront envoyées à l’ancienne version) et que les clients nouveaux/mis à niveau communiquent avec la nouvelle version de la ressource.

resourceVersion: number

Valeur de propriété

number