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

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.

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

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.