Créer et exporter des ressources de test

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

Consultez la documentation d' Apigee Edge.

Avant de tester les API, vous devrez peut-être créer un ensemble de ressources de test, telles que des produits API, des développeurs ou des applications, qui représentent ces ressources susceptibles d'exister dans l'environnement de production de votre organisation Apigee.

Créez et exportez des ressources de test, comme décrit dans les sections suivantes. Voir aussi Gérer les dossiers et les fichiers dans un espace de travail Apigee.

Créer des ressources de test

Pour créer des ressources de test, créez un groupe de test, puis modifiez les ressources de test définies dans le tableau suivant.

Ressource test Description
Produits d'API (products.json) Définissez les produits d'API utilisés pour regrouper les API et mettez-les à la disposition des développeurs.
Développeurs (developers.json) Enregistrez les développeurs qui auront accès à vos API.
Applications de développement (developerapps.json) Enregistrez des applications pour contrôler l'accès à vos API.
Mappages clé-valeur (maps.json) Définissez les mappings clé-valeur (KVM) utilisées par vos API pour stocker des données à récupérer au moment de l'exécution.

Créer un groupe de test

Pour créer un groupe de test dans Cloud Code :

  1. Effectuez l'une des actions suivantes :

    • Placez le curseur sur le dossier données de test dans votre espace de travail Apigee, puis cliquez sur Icône Créer un groupe de test. + s'affiche lorsque vous placez le curseur sur le dossier des tests.

    • Sélectionnez Affichage > Palette de commandes pour ouvrir la palette de commandes, puis sélectionnez Cloud Code : Créer un groupe de test Apigee.

  2. Saisissez un nom unique pour le groupe de test et appuyez sur Entrée.

Le groupe de test est ajouté au dossier données de test dans la section Apigee.

Dossier de test avec les fichiers developerapps.json, developers.json, maps.json et products.json

Configurez les ressources de test, comme décrit dans les sections suivantes.

Définir des produits d'API (products.json)

Définissez les produits d'API utilisés pour regrouper les API et mettez-les à la disposition des développeurs. Pour en savoir plus sur les produits d'API, consultez la page Qu'est-ce qu'un produit d'API ?

Pour définir des produits d'API, mettez à jour le fichier products.json à l'aide de l'assistant de configuration ou en modifiant le fichier de configuration products.json directement. Pour une description des champs du fichier products.json, consultez la section Ressource : ApiProduct.

Pour définir des produits d'API à l'aide de l'assistant de configuration :

  1. Placez le curseur sur le fichier products.json du groupe de test, puis cliquez sur Icône de l'assistant pour définir un produit d'API. L'assistant Créer un produit API s'ouvre.

    Première page de l'assistant de création de produit API

  2. Attribuez un nom au produit de l'API, puis suivez l'assistant de configuration pour renseigner automatiquement les champs du fichier products.json. Le fichier products.json est ouvert dans l'éditeur.

  3. Modifiez les informations de configuration si nécessaire.

  4. Sélectionnez File > Save (Fichier > Enregistrer) ou ⌘S pour enregistrer vos modifications.

L'exemple suivant définit le produit d'API myapiproduct contenant le proxy d'API helloworld.

[
  {
    "apiResources": [
      "/",
      "/*",
      "/**"
    ],
    "quota": "100",
    "quotaInterval": "1",
    "quotaTimeUnit": "minute",
    "name": "myapiproduct",
    "displayName": "My first API product",
    "proxies": [
      "helloworld"
    ]
  }
]

Inscription des développeurs (developers.json)

Enregistrez les développeurs qui auront accès à vos API. Pour en savoir plus sur les développeurs, consultez la page Enregistrer des développeurs d'applications.

Pour enregistrer les développeurs, mettez à jour le fichier developers.json à l'aide de l'assistant de configuration ou en modifiant le fichier de configuration developers.json directement. Pour une description des champs du fichier developers.json, consultez la section Ressource : Développeur.

Pour enregistrer les développeurs à l'aide de l'assistant de configuration :

  1. Placez le curseur sur le fichier developers.json du groupe de test, puis cliquez sur Icône de l'assistant Cloud Code pour enregistrer des développeurs.
  2. Saisissez l'adresse e-mail du développeur et d'autres valeurs dans l'assistant de configuration pour renseigner automatiquement les champs du fichier developers.json. Le fichier developers.json est ouvert dans l'éditeur.
  3. Modifiez la configuration si nécessaire.
  4. Sélectionnez File > Save (Fichier > Enregistrer) ou ⌘S pour enregistrer vos modifications.

L'exemple suivant définit le développeur ahamilton@example.com :

[
  {
    "email": "ahamilton@example.com",
    "userName": "ahamilton",
    "firstName": "Alex",
    "lastName": "Hamilton"
  }
]

Enregistrer des applications de développement (developerapps.json)

Enregistrez des applications de développement pour contrôler l'accès à vos API. Pour plus d'informations sur l'enregistrement des applications de développement, consultez la section Contrôler l'accès à vos API en enregistrant des applications.

Pour enregistrer des applications de développement, mettez à jour le fichier developerapps.json à l'aide de l'assistant de configuration ou en modifiant le fichier de configuration developerapps.json directement. Pour une description des champs du fichier developerapps.json, consultez la section Ressource : DeveloperApp.

Pour enregistrer des applications de développement à l'aide de l'assistant de configuration :

  1. Placez le curseur sur le fichier developerapps.json du groupe de test, puis cliquez sur Icône de l'assistant pour enregistrer des applications de développeur.

  2. Sélectionnez le développeur et d'autres valeurs pour renseigner automatiquement les champs du fichier developerapps.json. Le fichier developerapps.json est ouvert dans l'éditeur.

  3. Modifiez la configuration si nécessaire.

  4. Sélectionnez File > Save (Fichier > Enregistrer) ou ⌘S pour enregistrer vos modifications.

L'exemple suivant enregistre l'application de développement myapp pour ahamilton@example.com et associe myproduct :

[
  {
    "attributes": [
      {
        "name": "sample_attribute_0",
        "value": "sample_attribute_value_0"
      }
    ],
    "developerEmail": "ahamilton@example.com",
    "name": "myapp",
    "callbackUrl": "",
    "keyExpiresIn": "",
    "apiProducts": [
      "myproduct"
    ]
  }
]

Définir des mappages de clé-valeurs (maps.json)

Définissez les mappings clé-valeur (KVM) utilisées par vos API pour stocker des données à récupérer au moment de l'exécution. Pour en savoir plus sur les KVM, consultez la section Utiliser des mappages clé-valeur.

Pour définir des mappages de valeurs de clé, mettez à jour le fichier maps.json à l'aide de l'assistant de configuration ou en modifiant le fichier de configuration maps.json directement. Pour une description des champs du fichier maps.json, consultez la section Ressource KeyValueMap.

Pour définir des KVM à l'aide de l'assistant de configuration:

  1. Placez le curseur sur le fichier maps.json du groupe de test, puis cliquez sur Icône de l'assistant pour définir des mappages clé-valeur.
  2. Sélectionnez le champ d'application et d'autres valeurs pour renseigner automatiquement les champs du fichier maps.json. Le fichier maps.json est ouvert dans l'éditeur.
  3. Modifiez la configuration si nécessaire.
  4. Sélectionnez File > Save (Fichier > Enregistrer) ou ⌘S pour enregistrer vos modifications.

L'exemple suivant définit le KVM chiffré mykvm :

[
  {
    "name": "mykvm",
    "encrypted": true
  }
]

Exporter des ressources de test vers l'émulateur Apigee

Pour exporter les ressources de test vers l'émulateur Apigee :

  1. Placez le curseur sur le groupe de test que vous souhaitez exporter, puis cliquez sur Icône d'exportation de la ressource de test.

    L'icône d'exportation s'affiche lorsque vous placez votre curseur sur le nom du groupe de test

  2. Si plusieurs conteneurs pour l'émulateur Apigee sont en cours d'exécution, sélectionnez celui dans lequel vous souhaitez déployer l'environnement.

Les ressources de test actives apparaissent dans l'émulateur Apigee, comme illustré dans la figure suivante.

Ressources de test actives comprenant des produits d'API, des développeurs et des applications de développement

Affichez le contenu de la ressource de test afin d'obtenir des informations spécifiques sur les ressources, telles qu'une clé API pour les tests, générée automatiquement et incluse dans la ressource de test de l'application de développement.