Partager via

Importer une API OData

S’APPLIQUE À : Tous les niveaux de Gestion des API

Cet article montre comment importer un service conforme à OData en tant qu’API dans API Management.

Dans cet article, vous apprendrez comment :

  • Importer une description des métadonnées OData à l’aide du Portail Azure
  • Gérer le schéma OData dans le portail
  • Sécuriser l’API OData

Prérequis

  • Une instance d'API Management. Si vous n’avez pas encore d’instance Gestion des API Azure, suivez ce guide de démarrage rapide : Créer une instance Gestion des API Azure.

  • Un service présenté comme OData v2 ou v4.

Accéder à votre instance Gestion des API

  1. Dans le portail Azure, recherchez et sélectionnez Services de gestion des API :

    Capture d’écran qui montre les services de gestion des API dans les résultats de recherche.

  2. Sur la page des services de gestion des API, sélectionnez votre instance de gestion des API :

    Capture d’écran qui montre une instance de gestion des API sur la page des services de gestion des API.

Importer des métadonnées OData

  1. Dans le menu de gauche, sélectionnez API>APIs, puis + Ajouter une API.

  2. Sous Créer à partir de la définition, sélectionnez OData :

    Capture d’écran de la création d’une API à partir d’une spécification OData dans le portail.

  3. Entrez les paramètres de l’API. Vous pouvez mettre à jour vos paramètres ultérieurement en accédant à l’onglet Paramètres de l’API.

    1. Dans la spécification OData, entrez une URL pour un point de terminaison de métadonnées OData. Cette valeur est généralement l’URL de la racine du service, ajoutée à /$metadata. Vous pouvez également sélectionner un fichier XML OData local à importer.

    2. Entrez des paramètres supplémentaires pour configurer votre API. Les paramètres sont expliqués dans le tutoriel Importer et publier votre première API.

  4. Sélectionnez Create (Créer).

    L’API est ajoutée à la liste des API. Les jeux d’entités et les fonctions exposés dans la description des métadonnées OData s’affichent sous l’onglet Jeux d’entités et fonctions de l’API.

    Capture d’écran montrant les jeux d’entités et fonctions OData.

Mettre à jour le schéma OData

Vous pouvez accéder à un éditeur dans le portail pour afficher le schéma OData de votre API. Si l’API change, vous pouvez également mettre à jour le schéma dans API Management à partir d’un fichier ou d’un point de terminaison de service OData.

  1. Dans le portail, accédez à votre instance Gestion des API.

  2. Dans le menu de gauche, sélectionnez API, puis sélectionnez votre API OData.

  3. Sous l’onglet Jeux d’entités et fonctions , sélectionnez les points de suspension (...) en regard d’un jeu d’entités ou d’une fonction, puis sélectionnez Modifier.

    Capture d’écran montrant l’emplacement de la commande Edit.

  4. Examiner le schéma. Si vous souhaitez le mettre à jour, sélectionnez Mettre à jour à partir d’un fichier ou Mettre à jour le schéma à partir du point de terminaison.

    Capture d’écran de l’éditeur de schéma pour une API OData.

Tester votre API OData

  1. Dans le menu de gauche, sélectionnez API, puis sélectionnez votre API OData.

  2. Sous l’onglet Jeux d’entités et fonctions , sélectionnez les points de suspension (...) en regard d’un jeu d’entités ou d’une fonction, puis sélectionnez Test.

    Capture d’écran montrant la commande Test.

  3. Dans la console de test, entrez des paramètres de modèle, des paramètres de requête et des en-têtes pour votre test, puis sélectionnez Test. Pour plus d’informations sur le test des API dans le portail, consultez Tester la nouvelle API dans le portail.

Sécuriser votre API OData

Sécurisez votre API OData en appliquant des stratégies d’authentification et d’autorisation existantes et une stratégie de validation OData pour vous protéger contre les attaques par le biais de requêtes d’API OData.

Conseil

Dans le portail, configurez des stratégies pour votre API OData sous l’onglet Stratégies d’API.

Ajouter d’autres API

Vous pouvez composer une API à partir d'API exposées par différents services, notamment :

  • Une spécification OpenAPI
  • Une API SOAP
  • Une API GraphQL
  • Une application web hébergée dans Azure App Service
  • Les fonctions Azure
  • Azure Logic Apps
  • Azure Service Fabric

Remarque

Lorsque vous importez une API, les opérations sont ajoutées à votre API actuelle.

Pour ajouter une API à une API existante :

  1. Accédez à votre instance Azure API Management dans le portail Azure :

    Capture d’écran montrant la page des services API Management.

  2. Sélectionnez API dans la page Vue d’ensemble, ou sélectionnez API>API dans le menu de gauche.

    Capture d’écran montrant la sélection d’API dans la page Vue d’ensemble.

  3. Sélectionnez les points de suspension (...) à côté de l’API à laquelle vous souhaitez ajouter une autre API.

  4. Sélectionnez Importer dans le menu déroulant :

    Capture d’écran montrant la commande d’importation.

  5. Sélectionnez un service à partir duquel importer une API.

Contenu connexe

  • Last updated on