SAP Fiori - Services OData

OData est utilisé pour définir les meilleures pratiques requises pour créer et utiliser des API RESTful. Il vous aide à découvrir les changements, à définir des fonctions pour les procédures réutilisables et à envoyer des demandes par lots, etc.

Certaines des caractéristiques importantes sont -

  • OData fournit une fonction d'extension pour répondre à tous les besoins personnalisés de vos API RESTful.

  • REST signifie Representational State Transfer et il est parfois orthographié comme "ReST".

  • Il repose sur un protocole de communication sans état, client-serveur, pouvant être mis en cache. Dans pratiquement tous les cas, le protocole HTTP est utilisé.

  • REST est défini comme un style d'architecture pour la conception d'applications réseau.

  • OData vous aide à vous concentrer sur votre logique métier tout en créant des API RESTful sans avoir à vous soucier des approches pour définir les en-têtes de demande et de réponse, les codes d'état, les méthodes HTTP, les conventions d'URL, les types de médias, les formats de charge utile et les options de requête, etc.

  • Les API RESTful OData sont faciles à utiliser.

Cycle de vie de service OData

Le cycle de vie du service OData comprend la durée d'un service OData. Vous trouverez ci-dessous les étapes clés à prendre en compte dans un cycle de vie de service OData.

  • Activation du service OData.

  • Maintenance du service OData.

  • Maintenance des modèles et services, jusqu'au nettoyage du cache de métadonnées.

  • Les applications RESTful utilisent des requêtes HTTP pour publier des données pour créer ou mettre à jour, lire des données et supprimer des données. REST utilise HTTP pour les quatre opérations CRUD (Créer / Lire / Mettre à jour / Supprimer).

  • REST est une alternative légère aux mécanismes comme RPC (Remote Procedure Calls) et les services Web.

DU REPOS

REST est défini comme une option pour les services Web et les appels de procédure distante. Il est utilisé pour concevoir des applications réseau.

Services REST comme des services Web et prend en charge les fonctionnalités ci-dessous -

  • Travailler avec des pare-feu
  • Language-independent
  • Standards-based
  • Non dépendant de la plate-forme

Architecture REST

Vous trouverez ci-dessous les composants de l'architecture REST.

Ressources

Dans REST, l'état et la fonctionnalité sont présentés comme des ressources. Les ressources sont l'élément clé d'une conception RESTful, par opposition aux «méthodes» ou «services» utilisés dans les services Web RPC et SOAP.

RPC appelle comme "getProductName" et "getProductPrice"ne sont pas utilisés dans REST. Vous affichez les données produit en tant que ressource et cette ressource doit contenir toutes les informations requises.

Web de ressources

Cela signifie qu'une seule ressource ne doit pas contenir de données détaillées et qu'elle contient des liens vers des pages Web supplémentaires.

Serveur client

Dans le modèle client-serveur REST, un serveur de composants peut être un autre client de composants.

Aucun état de connexion

Chaque demande doit contenir des détails sur la connexion à chaque client et ne doit pas répondre sur les connexions précédentes au même client.

Cachable

Le protocole doit permettre au serveur de spécifier explicitement quelles ressources peuvent être mises en cache et pendant combien de temps.

Serveurs proxy

Pour améliorer les performances et l'évolutivité, des serveurs proxy peuvent être utilisés. Tout proxy HTTP standard peut être utilisé.

Service OData utilisant SAP NetWeaver Gateway Service Builder

Utilisez le T-Code: SEGW

Une nouvelle fenêtre s'ouvrira. Cliquez surCreate Project.

Maintenant, suivez les étapes ci-dessous -

  • Entrez le nom du projet comme indiqué dans l'image ci-dessous. Il doit être unique et ne doit contenir aucun caractère spécial.

  • Saisissez la description du projet car il s'agit d'un champ obligatoire.

  • Saisissez les différents attributs tels que le type de projet, la stratégie de génération.

  • Sélectionnez Package ou cliquez sur l'objet local, si vous souhaitez le créer localement.

Une fois que vous avez cliqué sur l'objet local, le générateur de services créera un nouveau projet avec une structure de dossiers vide. Tous ces éléments sont automatiquement créés avec un nouveau projet et cliquez sur l'icône de sauvegarde.

Maintenant, pour créer un type d'entité dans le modèle de données. Développez le modèle de données → clic droit → Créer → Type d'entité.

Entrez le nom du type d'entité et pour créer automatiquement un ensemble d'entités, cliquez sur l'option de case à cocher d'ensemble d'entités associées.

Cliquez sur l'option Insert rowpour ajouter un autre type d'entité dans le modèle de données et ajouter les détails comme indiqué ci-dessous. Cliquez sur Enregistrer.

De la même manière, vous pouvez créer un ensemble d'entités en cliquant avec le bouton droit sur le modèle de données et en saisissant les détails ou en utilisant le Insert Row option dans Type d'entité.

L'étape suivante consiste à définir l'association et la relation entre différentes entités. Il peut être créé de deux manières, en utilisant un assistant ou en utilisant la vue d'édition de masque.

  • Clic-droit data model → Create → Association ou

  • Clic-droit Association folder → Create

Double clic Association folder → Edit Mode → Insert Row

Entrez les détails des étiquettes données -

  • Nom de l'association
  • Éditeur d'association externe
  • Entité principale et cardinalité
  • Entité dépendante et cardinalité

Clique le Association set. Clic-droitdata model → Create → Association Set.

Créer Function Import dans Service Builder, faites un clic droit Data Model → Create → Function Import.

Entrez le nom de Function Import et vous pouvez choisir parmi d'autres options et cliquer sur le save icon.

Pour définir un type complexe, accédez à Data Model → right Click → Complex type.

Entrez les détails selon l'exigence et enregistrez.

C'est ainsi que vous pouvez créer un modèle de données, un ensemble d'entités, un type, une association et des types complexes.

Comment importer un modèle de données

Il existe quatre options disponibles pour importer un modèle de données à partir d'un fichier -

  • Modèle de données à partir d'un fichier
  • Structure DDIC
  • Interface RFC / BOR
  • Aide à la recherche

Pour importer un modèle de données, suivez les étapes ci-dessous -

Run T-code: SEGW

Cliquez avec le bouton droit sur Nom du projet → Importer → Sélectionnez la méthode d'importation

Entrez le chemin et importez les types d'entités, les ensembles d'entités, les associations et les types complexes.

Mappage à la source de données

Allez dans Modèle de données → Mise en œuvre du service → sélectionnez Ensemble d'entités pour le mappage

Entrez la source de données du système local ou distant, tapez et nommez et enregistrez.

Cela activera le nœud de mappage sous l'opération de requête. Vous pouvez effectuer un mappage pour des objets uniques ou utiliser également l'option dePropose mapping option.

Maintenance et enregistrement du service

Aller à Data Model. Double-cliquezService Maintenance.

Sélectionnez le système que vous souhaitez enregistrer et cliquez sur le Register option en haut.

Sélectionnez le project → Local Object puis enregistrez en cliquant sur la coche.

Vérifier la Service Registration statut.

Pour maintenir le service, cliquez sur le Maintainbouton. Une autre fenêtre s'ouvrira.

Cliquez sur Call browseret choisissez d'utiliser ce service comme URL. Cliquez surOK.

Un navigateur s'ouvrira; entrez le nom d'utilisateur et le mot de passe pour voir si le service est exposé en tant que service OData.