Étape 6 : Publier une API

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

Consultez la documentation d'Apigee Edge.

Lors de cette étape, vous allez publier une API sur le portail en procédant comme suit :

  1. Créer un proxy d'API à partir d'une spécification
  2. Créer un produit d'API
  3. Publier l'API sur votre portail

Étape 1 : Créer un proxy d'API à partir d'une spécification

Créez un proxy d'API à partir d'une spécification OpenAPI qui décrit l'API.

Pour créer un proxy d'API à partir d'une spécification OpenAPI, procédez comme suit :

  1. Dans l'interface utilisateur Apigee, sélectionnez Develop > API proxies (Développer > Proxys d'API) dans la barre de navigation de gauche pour ouvrir la page Proxys d'API.

  2. Cliquez sur Créer.
    Ajouter un proxy d'API

    L'assistant de création de proxy s'ouvre et vous invite à sélectionner le type de proxy d'API à créer.

  3. Sous Proxy inverse (le plus courant), cliquez sur Utiliser la spécification OpenAPI. Utiliser la spécification OpenAPI

    La boîte de dialogue Use OpenAPI Spec (Utiliser la spécification OpenAPI) s'affiche.

  4. Copiez et collez l'URL suivante dans le champ URL de spécification OpenAPI de l'onglet URL :

    https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml

  5. Cliquez sur Select (Sélectionner).
    L'assistant Create Proxy (Créer un proxy) s'ouvre, et la page Proxy details (Détails du proxy) est renseignée à l'aide des valeurs de la spécification OpenAPI.

    Page des détails du proxy de l'assistant "Créer un proxy", préremplie avec du contenu

  6. Modifiez le champ Description comme suit : proxy d'API pour Hello World.

  7. Cliquez sur Next (Suivant).

  8. Sur la page Policies (Règles) :

    • Sous Security: Authorization (Sécurité : Autorisation), sélectionnez Pass through (no authorization) (Directe [sans autorisation]).
    • Sous Security: Browser (Sécurité : Navigateur), sélectionnez Add CORS headers (Ajouter des en-têtes CORS).

    Page des règles courantes de l'assistant de création de proxy avec la règle directe et les en-têtes CORS sélectionnés

  9. Cliquez sur Next (Suivant).

  10. Sur la page Flows (Flux), assurez-vous que toutes les opérations sont sélectionnées et cliquez sur Suivant.
    Créer des flux de proxy

  11. Sur la page Summary (Résumé), sélectionnez l'environnement dans lequel vous souhaitez effectuer le déploiement sous Optional Deployment (Déploiement facultatif).

  12. Cliquez sur Create and deploy (Créer et déployer).

Sur la page Résumé, un message de confirmation indique que votre nouveau proxy d'API a été créé et déployé dans l'environnement sélectionné.

Étape 2 : Créer un produit d'API

Créez un produit d'API contenant les ressources d'API que vous souhaitez exposer aux utilisateurs de l'API.

Pour créer un produit API, procédez comme suit :

  1. Dans l'interface utilisateur Apigee, sélectionnez Publish > API Products (Publier > Produits d'API) dans la barre de navigation de gauche pour ouvrir la page des produits d'API.
  2. Cliquez sur +CRÉER.
    La page "Produit" s'affiche.
  3. Saisissez les détails du produit API.
    Remarque : Les champs Nom à afficher et Description s'affichent sur le portail lorsque vous publiez le produit d'API, par défaut. Vous pouvez modifier les valeurs de l'Étape 3 : Publier l'API sur votre portail.
    Champ Valeur
    Nom Hello World
    Nom à afficher Hello World
    Description Exemple "Hello World" simple
    Environnement Sélectionnez l'environnement dans lequel le proxy d'API est déployé.
    Accès Public
    Approuver automatiquement les requêtes d'accès Activée
    Quota (laissez le champ vide)
    Champs d'application OAuth autorisés (laissez le champ vide)
  4. Dans la section Opérations, cliquez sur AJOUTER UNE OPÉRATION pour identifier les opérations à ajouter à votre produit d'API.
  5. Sous Source, cliquez sur API Proxy (Proxy d'API) et sélectionnez Mock-Target-API dans le menu déroulant.
  6. Sous Operation (Opération), saisissez une barre oblique (/) dans le champ Path (Chemin d'accès). Ignorez les autres champs.
  7. Cliquez sur Save (Enregistrer) pour enregistrer l'opération.
  8. La boîte de dialogue Ajouter une opération s'affiche. Ajouter un proxy d'API de simulation cible dans la boîte de dialogue Ajouter une opération
  9. Cliquez sur Ajouter.
  10. Cliquez sur Enregistrer.

Étape 3 : Publier l'API sur votre portail

Publiez l'API sur votre portail pour permettre à vos clients de se familiariser avec celle-ci et de l'utiliser.

Pour publier l'API sur votre portail, procédez comme suit :

  1. Dans l'UI d'Apigee, accédez à la page des API de votre portail :
    1. Sélectionnez Publier > Portails dans la barre de navigation de gauche.
    2. Cliquez sur la ligne Mon premier portail pour ouvrir le portail.
    3. Cliquez sur Catalogue d'API pour afficher la page des API.
  2. Cliquez sur le signe +.
  3. Sélectionnez Hello World dans la boîte de dialogue Ajouter un produit d'API au catalogue, puis cliquez sur Suivant.
  4. Sous API details (Détails de l'API), configurez les options suivantes :
    • Sélectionnez Published (listed in the catalog) (Publié [répertorié dans le catalogue]) pour publier l'API sur votre portail.
    • Pour Display image (Image à afficher) :
      1. Cliquez sur Select image (Sélectionner une image).
      2. Cliquez sur home-background.jpg dans la liste des images existantes de la boîte de dialogue Select image.
      3. Cliquez sur Select (Sélectionner).
      4. Prévisualisez l'image et cliquez sur Select (Sélectionner).
    • Pour Categories (Catégories), saisissez Get Started (Premiers pas) et appuyez sur Entrée.

    Conservez toutes les autres valeurs par défaut.

    Section "Détails de l'API" lors de l'ajout d'une API au portail

  5. Sous API documentation (Documentation de l'API), pour générer automatiquement la documentation de référence de l'API à partir d'un instantané de votre spécification OpenAPI, procédez comme suit :
    1. Sélectionnez OpenAPI document (Document OpenAPI).
    2. Cliquez sur Select Document (Sélectionner un document).
    3. Sélectionnez l'onglet Import from a URL (Importer à partir d'une URL).
    4. Saisissez helloworld dans le champ Spec name (Nom de la spécification).
    5. Copiez et collez l'URL suivante dans le champ URL, puis appuyez sur Entrée : 
      https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml
    6. Cliquez sur Select (Sélectionner).

    Section "Documentation de l'API" lors de l'ajout d'une API au portail

  6. Cliquez sur Enregistrer.

Pour afficher la documentation de référence de l'API, procédez comme suit :

  1. Dans l'interface utilisateur d'Apigee, cliquez sur Live Portal (Portail en ligne) pour afficher les modifications dans le portail (ou actualisez le portail en ligne s'il est déjà ouvert dans un autre onglet).
  2. Dans le portail en ligne :
    a. Cliquez sur APIs (API) dans la barre de navigation supérieure pour afficher l'API publiée.
    Cliquez sur la fiche Hello World pour afficher la documentation de référence de l'API.
    Essayez votre API !

API de simulation cible avec le panneau "Essayer cette API"