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 à l’aide de sa description des métadonnées. SAP Gateway Foundation est utilisé comme exemple.

Dans cet article, vous découvrirez comment :

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

Prérequis

• Une instance API Management. Si vous n’en avez pas, effectuez les étapes décrites dans Créer une instance Gestion des API à l’aide du portail Azure.

• Un système SAP et un service qui sont exposés en tant qu’OData v2 ou v4.

• Si votre 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 principal SAP.
  3. Décochez les cases Valider la chaîne de certificats et Valider le nom de certificat.

  Remarque

  Dans les 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

Utilisez l’une des méthodes suivantes pour récupérer le code XML des métadonnées à partir de votre service SAP. 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 code 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 de gestion des API :

   

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

   

Importer une API dans Gestion des API

Choisissez l’une des méthodes suivantes pour importer votre API dans Gestion des API :

• Importez directement le code XML des métadonnées en tant qu’API OData.
• Convertissez le 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, sélectionnez API>APIs, puis + Ajouter une API.

2. Sous Créer à partir de la 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 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.

   

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.

   

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

   

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.

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.

   L’exemple suivant convertit le code XML OData v2 pour le service epm_ref_apps_prod_man_srvde test :

   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
   

   Remarque

   • Pour les tests avec un seul fichier XML, vous pouvez utiliser un convertisseur web basé sur un 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 également ajouter ces informations ultérieurement dans votre spécification OpenAPI générée ou après avoir importé le fichier dans Gestion des API.

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

Importer la spécification OpenAPI

1. Dans le volet de navigation gauche, dans la section API , sélectionnez API.

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

   

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

4. Entrez les paramètres de l’API. Vous pouvez définir ces valeurs lorsque vous importez l’API ou les configurez ultérieurement en accédant à l’onglet Paramètres.

   • Pour le suffixe d’URL de l’API, nous vous recommandons d’utiliser le même chemin d’URL que celui du 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).

Remarque

Pour plus d’informations sur les limitations d’importation d’API, consultez les restrictions d’importation d’API et les problèmes connus.

Terminer la configuration de l’API

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

• GET /$metadata

  Opération	Descriptif	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	Descriptif
  HEAD /	Permet au client d’échanger des jetons de falsification de requête intersites (CSRF) avec le serveur SAP, quand cela est nécessaire. SAP autorise également l’échange de jetons CSRF via 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.

  

• GET /

  Opération	Descriptif	Configuration supplémentaire pour l’opération
  GET /	Active la configuration de 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 entre les requêtes avec et sans barres obliques de fin. Ces deux types de requêtes sont traités différemment par certains back-ends.

  

Vous devez également configurer l’authentification sur votre back-end à l’aide d’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 volet de navigation gauche, dans 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 serveur principal SAP.

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

7. Lorsque vous avez terminé le test, quittez la console de test.

Considérations relatives à la production

• Consultez un exemple de scénario de bout en bout pour intégrer Gestion des API à une passerelle SAP.
• Contrôler l’accès à un back-end SAP à l’aide de stratégies gestion des API. Par exemple, si l’API est importée en tant qu’API OData, utilisez la stratégie Valider la requête OData. Il existe également des extraits de stratégie pour la propagation du principal SAP pour SAP ECC ou S/4HANA ou SAP SuccessFactors et l’extraction d’un jeton X-CSRF.
• Pour obtenir des conseils sur le déploiement, la gestion et la migration d’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.

Contenu connexe

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