Présentation des ressources d'API

Cette page s'applique à Apigee et à Apigee hybrid.

Lorsque vous enregistrez une API auprès du hub d'API, vous créez et stockez une entité qui représente l'API. Nous appelons cette entité une ressource d'API. Les ressources d'API stockées dans le hub d'API sont incluses dans l'index de recherche, et fournissent des informations opérationnelles et descriptives détaillées sur l'API.

Une ressource d'API est une entité complexe pouvant être associée à une ou plusieurs versions. Vous pouvez considérer une version comme l'état d'une API à un moment donné. Chaque version peut avoir son propre ensemble d'entités, telles que les opérations analysées à partir d'une spécification d'API, les déploiements et les spécifications d'API, comme illustré à la Figure 1.

Relations entre les entités d'API.

Figure 1. Une API peut avoir plusieurs versions.

Lors de l'enregistrement d'une API, ou suite à cet enregistrement, vous pouvez ajouter et modifier les attributs de la ressource d'API afin de constituer une description détaillée de l'API. Consultez la section Gérer les attributs.

Le hub d'API est compatible avec les attributs définis par le système et définis par l'utilisateur. Voici quelques exemples d'attributs définis par le système:

  • Style d'API: attribut avec les valeurs par défaut de l'API REST, gRPC, SOAP et asynchrone.
  • Utilisateurs cibles : utilisateurs visés (consommateurs) d'une API.
  • Équipe : la ou les équipes de production responsables d'une API.
  • Unité commerciale : unité commerciale responsable d'une API.
  • Niveau de maturité : indication de l'étape du cycle de vie de l'API.

Enfin, une ressource d'API peut avoir des attributs définis par l'utilisateur, que vous définissez dans les paramètres en fonction des besoins de votre organisation ou de votre équipe.