Étape 6 : Publier une API

Vous consultez la documentation d'Apigee Edge.
Accédez à la documentation sur Apigee X. info

Lors de cette étape, vous allez publier une API sur le portail en procédant comme suit:
1. Créer une spécification OpenAPI
2. Créer un proxy d'API à partir d'une spécification
3. Créer un produit API
4. Publier l'API sur votre portail

Étape 1: Créer une spécification OpenAPI

Chaque spécification OpenAPI sert de source de vérité tout au long du cycle de vie de l'API. La même spécification est utilisée à chaque phase du cycle de vie de l'API, du développement à la publication.

Pour créer une spécification OpenAPI:

  1. Sélectionnez Développer > Spécifications dans la barre de navigation de gauche pour ouvrir la page Spécifications.
  2. Cliquez sur + Spec > Import URL (+ Spécification > Importer l'URL).
  3. Saisissez les informations suivantes dans la boîte de dialogue d'importation:
  4. Nom de l'importation: helloworld

  5. URL d'importation: https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml

  6. Cliquez sur Importer.

Étape 2: 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. Sur la page "Spécifications", placez le curseur sur la spécification helloworld pour afficher le menu d'actions.
  2. Cliquez sur  pour générer un proxy d'API à partir de la spécification.
    L'assistant Build a Proxy (Créer un proxy) s'ouvre, et la page Details (Détails) est renseignée à l'aide des valeurs de la spécification OpenAPI.
  3. Modifiez le champ Description comme suit : proxy d'API pour Hello World.
  4. Cliquez sur Suivant.

  5. 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

  6. Cliquez sur Suivant.

  7. 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

  8. Sur la page "Hôtes virtuels", assurez-vous que tous les hôtes virtuels sont sélectionnés, puis cliquez sur Suivant.

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

  10. Cliquez sur Créer.

Sur la page "Résumé", un message vous indique que votre nouveau proxy d'API a été créé et déployé dans votre environnement de test.

Étape 3: 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. Sélectionnez Publier > Produits API dans la barre de navigation de gauche pour ouvrir la page Produits API.
  2. Cliquez sur + Produit API.
    La page New Product (Nouveau 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 4: 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é
    Quota (laissez le champ vide)
    Champs d'application OAuth autorisés (laissez le champ vide)
  4. Sous Ressources liées aux API, cliquez sur Ajouter un proxy pour identifier les proxys d'API à ajouter à votre produit d'API.
    La boîte de dialogue Ajouter une ressource d'API s'affiche.
  5. Cliquez sur API Proxy (Proxy d'API) (s'il n'est pas déjà sélectionné) et sélectionnez Mock-Target-API dans la liste.
  6. Cliquez sur Ajouter.
  7. Cliquez sur Save (Enregistrer) pour enregistrer le produit d'API.

    Produit d'API Hello World affichant tous les champs définis

Étape 4: 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. 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 Sélectionner une 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.

  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 Mes spécifications (s'il n'est pas déjà sélectionné).
    4. Sélectionnez helloworld dans la liste des spécifications.
    5. Cliquez sur Sélectionner.
  6. Cliquez sur Enregistrer pour enregistrer les informations de l'API.

    API Hello World affichant tous les champs définis

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

  1. Cliquez sur Live Portal (Portail actif) pour afficher les modifications apportées à celui-ci (ou actualisez le portail s'il est déjà ouvert dans un autre onglet).
  2. Cliquez sur API dans la barre de navigation supérieure pour afficher l'API publiée.
  3. 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"

Félicitations ! Vous avez terminé le tutoriel. Vous souhaitez en savoir plus ? Accédez à Créer votre portail intégré.