Définition des propriétés d'API

Modifier en ligne

Outre les propriétés d'API préfournies que vous pouvez utiliser pour contrôler le comportement des stratégies API Connect , vous pouvez définir vos propres propriétés d'API. Les propriétés que vous définissez peuvent être référencées dans vos définitions d'API.

A propos de cette tâche

Remarque: Cette tâche concerne la configuration d'une définition d'API OpenAPI 2.0 . Pour plus d'informations sur la configuration d'une définition d'API OpenAPI 3.0 , voir Edition d'une définition d'API OpenAPI 3.0.

Vous pouvez effectuer cette tâche soit à l'aide de l'application d'interface utilisateur API Designer , soit à l'aide de l'interface utilisateur API Manager basée sur un navigateur.

Les propriétés d'API incluent le nom et la valeur de propriété, ainsi que le catalogue auquel la valeur de propriété s'applique. Pour obtenir la liste des propriétés API prédéfinies relatives aux différentes politiques, consultez la section « Propriétés API ».

Remarque: une fois définie, une propriété d'API est en lecture seule.

Pour savoir comment faire référence à une propriété dans une définition d'API, consultez la section « Références aux variables » dans API Connect.

Il est également possible de définir des propriétés spécifiques à un catalogue et qui peuvent être référencées par l'une des API de ce catalogue. Pour plus d'informations, voir Création et configuration de catalogues. Notez que si vous définissez une propriété de catalogue du même nom qu'une propriété d'API, la propriété d'API est prioritaire sur la propriété de catalogue.

À tout moment, vous pouvez accéder directement au fichier YAML source d' OpenAPI en cliquant sur l'icône Source OpenAPI Icône Source . Pour revenir au formulaire de conception, cliquez sur l'icône Formulaire Icône de formulaire .

Astuce: Si vous ajoutez ou modifiez une propriété d'API sur une API qui est déjà mise en préproduction ou publiée, vous devez remettre en préproduction ou republier le produit qui contient l'API mise à jour pour que la modification soit prise en compte.

Procédure

Ouvrez l'API pour édition, comme décrit dans Edition d'une définition d'API OpenAPI 2.0.
Sélectionnez l'onglet Passerelle , développez Paramètres de passerelle et de portail , puis, si une ou plusieurs propriétés d'API sont déjà définies, développez Propriétés.
Configurez une propriété d'API.
- Pour définir une nouvelle propriété d'API, procédez comme suit :
  1. Cliquez sur l'icône « Ajouter » située à côté de « Propriétés » dans le volet de navigation.
  2. Fournissez les informations suivantes :
    - Nom de la propriété : Entrez un nom pour la propriété. Ce nom est utilisé pour référencer la propriété. Le jeu de caractères suivant est pris en charge pour le nom d'une propriété d'API: [A-Za-z0-9_-]+. Les espaces sont autorisés.
    - Valeur de la propriété: valeur par défaut de la propriété. Laissez cette zone vide si la propriété doit avoir une valeur NULL par défaut.
    - Description : Description facultative de la propriété. Vous pouvez utiliser la syntaxe CommonMark pour afficher du texte formaté.
    - Sélectionnez La valeur de la propriété est Base64 Encoded si vous souhaitez masquer les valeurs de propriété ou protéger les mots de passe utilisateur contre une utilisation occasionnelle.
      Remarque: Si vous codez une valeur de propriété, elle est sauvegardée au format codé Base64 ; elle n'est pas chiffrée. Si vous décochez par la suite la case Coder, la valeur d'origine de la propriété est restaurée dans son format non codé.
  3. Cliquez sur Créer.
- Pour modifier une propriété d'API existante, cliquez sur le nom de la propriété dans le panneau de navigation. Vous pouvez ensuite modifier les paramètres de configuration.
Cliquez sur Sauvegarder pour sauvegarder vos modifications.