É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 :

Interface utilisateur de la console Cloud

1. Dans la console Apigee dans Cloud, accédez à la page Développement de proxys > Proxys d'API.

   Accéder aux proxys d'API

2. Cliquez sur Créer. L'assistant Créer un proxy s'ouvre et vous invite à sélectionner le type de proxy d'API à créer.

3. Cliquez dans la zone Modèle de proxy.

4. Cliquez sur Modèle de spécification OpenAPI, proxy inverse (le plus courant).

5. Ouvrez le fichier suivant dans un navigateur, puis enregistrez-le :

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

6. Dans Étape 1 : Spécifications OpenAPI, cliquez sur Parcourir.

7. Accédez à un fichier de spécification OpenAPI que vous venez de télécharger, sélectionnez-le, puis cliquez sur Ouvrir.

8. Cliquez sur Suivant.

9. À l'étape 2 : Détails du proxy, les champs sont préremplis à l'aide des valeurs de la spécification OpenAPI. Modifiez le champ Description comme suit : proxy d'API pour Hello World.

10. Cliquez sur Suivant.

11. Dans Étape 3 : Flux, sélectionnez toutes les opérations.

12. Cliquez sur Suivant.

13. À l'étape 4 : Déployer, sélectionnez l'environnement dans lequel vous souhaitez effectuer le déploiement.

14. Cliquez sur OK.

15. Cliquez sur Créer.

Remarque : Le déploiement du nouveau proxy par Apigee peut prendre quelques instants.

Une fois le proxy déployé, la colonne État de la section Déploiements affiche une icône verte indiquant que la révision du proxy d'API est déployée. Vous pouvez maintenir le pointeur de la souris sur l'icône d'état pour en savoir plus sur le déploiement.

UI classique

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.

   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.

   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 Sélectionner. L'assistant Create Proxy (Créer un proxy) s'ouvre, et la page Proxy details (Détails du proxy) est préremplie à l'aide des valeurs de la spécification OpenAPI.

   

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

7. Cliquez sur 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).

   

9. Cliquez sur Suivant.

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

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 d'API :

1. Dans la console Cloud Apigee, accédez à la page Distribution > Produits d'API.

   Accéder aux produits d'API

2. Cliquez sur Créer. La page Informations sur le produit s'affiche. 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é
   Quota	(laissez le champ vide)
   Champs d'application OAuth autorisés	(laissez le champ vide)

3. Dans la section Opérations, cliquez sur Ajouter une opération pour identifier les opérations à ajouter à votre produit d'API.

   • Sous Source, sélectionnez Proxy d'API, puis Mock-Target-API dans le menu déroulant.
   • Sous Operation (Opération), saisissez une barre oblique (/) dans le champ Path (Chemin d'accès). Ignorez les autres champs.

4. Cliquez sur Enregistrer pour enregistrer l'opération.

5. Cliquez sur Enregistrer pour enregistrer le produit.

É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 :

Interface utilisateur de la console Cloud

1. Dans la console Apigee dans Cloud, accédez à la page Distribution > Portails.

   Accéder à "Portails"

2. Cliquez sur la ligne Mon premier portail pour ouvrir le portail.

3. Cliquez sur l'onglet API.

4. Cliquez sur + API.

5. Pour Produit d'API, sélectionnez Hello World.

6. Sélectionnez Published (listed in the catalog) (Publié [répertorié dans le catalogue]) pour publier l'API sur votre portail.

7. Dans le champ Titre à afficher, saisissez Hello World.

8. Pour Image à afficher, cliquez sur Sélectionner.

9. Cliquez sur Composants.

10. Cliquez sur Aperçu pour home-background.jpg.

11. Cliquez sur Sélectionner.

12. Pour API documentation (Documentation de l'API), afin de générer automatiquement la documentation de référence de l'API à partir d'un instantané de votre spécification OpenAPI :

    1. Sélectionnez OpenAPI document (Document OpenAPI).
    2. Cliquez sur Sélectionner.
    3. Cliquez sur l'onglet URL.
    4. Saisissez helloworld dans le champ Nom de la spécification.
    5. Copiez et collez l'URL suivante dans le champ URL :

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

    6. Cliquez sur Sélectionner.

13. Cliquez sur Enregistrer.

UI classique

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 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 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 :
   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 Sélectionner.

   

6. Cliquez sur Enregistrer.

Étape 4 : Consultez la documentation de référence de l'API

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

1. Dans l'UI Apigee, 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. Dans le portail en ligne :
   1. Cliquez sur API dans la barre de navigation supérieure pour afficher l'API publiée.
   2. Cliquez sur la fiche Hello World pour afficher la documentation de référence de l'API.
   3. Essayez votre API !

Félicitations ! Vous avez terminé le tutoriel. Vous souhaitez en savoir plus ? Consultez la documentation du portail Apigee.