Importer des métadonnées OData de SAP en tant qu’API

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

Cet article explique comment importer un service OData en utilisant sa description de métadonnées. Dans cet article, nous prenons l’exemple du service SAP Gateway Foundation.

Dans cet article, vous allez :

• Récupération de métadonnées OData à partir de votre service SAP
• Importation de métadonnées OData dans Gestion des API, directement ou après conversion vers une spécification OpenAPI
• Configurer l’API
• Tester l’API dans le portail Azure

Prérequis

• Disposer d’une instance d’API Management. Si vous ne l’avez pas déjà fait, créez-en un.

• Un système et un service SAP exposés comme OData v2 ou v4.

• Si votre serveur back-end SAP utilise un certificat auto-signé (pour les tests), vous devrez peut-être désactiver la vérification de la chaîne d’approbation pour SSL. Pour ce faire, configurez un serveur back-end dans votre instance API Management :

  1. Dans le portail Azure, sous API, sélectionnez Backends>+ Ajouter.
  2. Ajoutez une URL personnalisée qui pointe vers le service back-end SAP.
  3. Décochez Valider la chaîne de certificats et Valider le nom du certificat.

  Notes

  Dans des scénarios de production, utilisez des certificats appropriés pour la vérification SSL de bout en bout.

Récupération de métadonnées OData à partir de votre service SAP

Récupérez le fichier XML des métadonnées de votre service SAP en utilisant l’une des méthodes suivantes. Si vous envisagez de convertir le fichier XML de métadonnées en spécification OpenAPI, enregistrez le fichier localement.

• Utilisez le client de passerelle SAP (transaction /IWFND/GW_CLIENT ) ou
• Effectuez un appel HTTP direct pour récupérer le XML : http://<OData server URL>:<port>/<path>/$metadata

Accéder à votre instance Gestion des API

1. Dans le Portail Azure, recherchez et sélectionnez Services API Management.

   

2. Dans la page Services Gestion des API, sélectionnez votre instance Gestion des API.

   

Importation d’une API dans Gestion des API

Choisissez l’une des méthodes suivantes pour importer votre API dans Gestion des API : importez directement le fichier XML de métadonnées en tant qu’API OData ou convertissez le fichier XML de métadonnées en spécification OpenAPI.

Métadonnées OData

Importer des métadonnées OData

1. Dans le menu de gauche, cliquez sur API > + Ajouter une API.

2. Sous Créer à partir d’une définition, sélectionnez OData.

   

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 spécification OData, saisissez l’URL d’un point de terminaison de métadonnées OData, généralement l’URL à la racine du service, ajoutée de /$metadata. Vous pouvez également sélectionner un fichier XML OData local à importer.

   2. Entrez les paramètres restants 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.

   

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, cliquez sur API> votre API OData.

3. Sous l’onglet Jeux d’entités et fonctions, sélectionnez le menu contextuel (...) à côté d’un jeu d’entités ou d’une fonction, puis sélectionnez Modifier.

   

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.

   

Tester votre API OData

1. Dans le menu de gauche, cliquez sur API> votre API OData.

2. Sous l’onglet Jeux d’entités et fonctions, sélectionnez le menu contextuel (...) à côté d’un jeu d’entités ou d’une fonction, puis sélectionnez Tester.

   

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 Tester. En savoir plus sur le test d’une API dans le portail.

Sécuriser votre API OData

Sécurisez votre API OData en appliquant les stratégies d’authentification et d’autorisation existantes et une stratégie de validation OData pour vous protéger contre les attaques en utilisant des demandes d’API OData.

Conseil

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

Spécification OpenAPI

Convertir des métadonnées OData en OpenAPI JSON

1. Convertissez le XML OData au format OpenAPI JSON. Utilisez un outil open source OASIS pour OData v2 ou OData v4 en fonction de vos métadonnées XML.

   Voici un exemple de commande qui convertit le XML OData v2 pour le service de test epm_ref_apps_prod_man_srv :

   odata-openapi -p --basePath '/sap/opu/odata/sap/epm_ref_apps_prod_man_srv' \
    --scheme https --host <your IP address>:<your SSL port> \
    ./epm_ref_apps_prod_man_srv.xml
   

   Notes

   • Pour les tests avec un seul fichier XML, vous pouvez utiliser un convertisseur web basé sur l’outil open source.
   • Avec l’outil ou le convertisseur web, la spécification des informations <adresse IP>:<port> de votre serveur OData SAP est facultative. Vous pouvez ajouter ces informations plus tard dans la spécification OpenAPI générée ou après l’importation dans API Management.

2. Enregistrez le fichier openapi-spec.json localement en vue de l’importation dans API Management.

Importer et publier une API back-end

1. Dans le menu de navigation latéral, sous la section API, sélectionnez API.

2. Sous Créer une définition, sélectionnez Spécification OpenAPI.

   

3. Cliquez sur Sélectionner un fichier, puis sélectionnez le fichier openapi-spec.json que vous avez enregistré localement à l’étape précédente.

4. Entrez les paramètres de l’API. Vous pouvez définir les valeurs lors de la création, ou les configurer ultérieurement en accédant à l’onglet Paramètres.

   • Dans Suffixe de l’URL de l’API, utilisez le même chemin d’URL que dans le service SAP d’origine.

   • Pour plus d’informations sur les paramètres d’API, consultez le tutoriel Importer et publier votre première API.

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

Notes

Les limitations relatives à l’importation d’API sont documentées dans un autre article.

Configurer l’API

Ajoutez les trois opérations suivantes à l’API que vous avez importée.

• GET /$metadata

  Opération	Description	Configuration supplémentaire pour l’opération
  GET /$metadata	Permet à API Management d’atteindre le point de terminaison $metadata, ce qui est nécessaire pour l’intégration du client au serveur OData. Cette opération obligatoire n’est pas incluse dans la spécification OpenAPI que vous avez générée et importée.	Ajoutez une réponse 200 OK.

  

• HEAD /

  Opération	Description	Configuration supplémentaire pour l’opération
  HEAD /	Permet au client d’échanger des jetons de falsification de requête intersites (CSRF, Cross Site Request Forgery) avec le serveur SAP, quand cela est nécessaire. SAP permet également l’échange de jetons CSRF avec le verbe GET. L’échange de jetons CSRF n’est pas abordé dans cet article. Consultez un exemple d’extrait de stratégie API Management pour répartir l’échange de jetons.	N/A

  

• GET /

  Opération	Description	Configuration supplémentaire pour l’opération
  GET /	Active la configuration de la stratégie à la racine du service.	Configurez la stratégie rewrite-uri entrante suivante pour ajouter une barre oblique de fin aux requêtes transmises à la racine du service : <rewrite-uri template="/" copy-unmatched-params="true" /> Cette stratégie supprime l’ambiguïté potentielle des requêtes avec ou sans barre oblique de fin, qui sont traitées différemment par certains points de terminaison.

  

En outre, configurez l’authentification sur votre serveur back-end en choisissant une méthode appropriée pour votre environnement. Pour voir des exemples, consultez Stratégies d’autorisation et d’authentification de Gestion des API.

Tester l’API

1. Accédez à votre instance API Management.

2. Dans le menu de navigation latéral, sous la section API, sélectionnez API.

3. Sous Toutes les API, sélectionnez l’API que vous avez importée.

4. Sélectionnez l’onglet Test pour accéder à la console de test.

5. Sélectionnez une opération, entrez les valeurs requises, puis sélectionnez Envoyer.

   Par exemple, testez l’appel GET /$metadata pour vérifier la connectivité au back-end SAP.

6. Affichez la réponse. Pour résoudre les problèmes, suivez l’appel.

7. Une fois le test effectué, quittez la console de test.

Considérations relatives à la production

• Consultez un exemple de scénario de bout en bout qui intègre API Management à une passerelle SAP.
• Contrôlez l’accès à un back-end SAP à l’aide de stratégies disponibles dans API Management. Par exemple, si l’API est importée en tant qu’API OData, utilisez la stratégie Valider la requête OData. Consultez également les extraits de code de stratégie pour la propagation de principal SAP et l’extraction d’un jeton X-CSRF.
• Pour obtenir des conseils sur le déploiement, la gestion et la migration des API à grande échelle, consultez :
  • Déploiements d’API automatisés avec APIOps
  • CI/CD pour la gestion des API à l’aide de modèles Azure Resource Manager.

Rubriques connexes

• Limitations de l’importation d’API
• Importer une spécification OpenAPI
• Importer une API SOAP
• Importer une API SOAP et la convertir pour REST
• Importer une API App Service
• Importer une API Container App
• Importer une API WebSocket
• Importer une API GraphQL
• Importer un schéma GraphQL et configurer des résolveurs de champs
• Importer une application de fonction Azure
• Importer une application logique Azure
• Importer un service Service Fabric
• Importer une API Azure OpenAI
• Importer une API OData
• Importer des métadonnées OData de SAP
• Importer une API gRPC
• Modifier une API