Mais c’est quoi à la fin OData ?
J’aborde OData dans différents articles, aussi pour éviter de me répéter dans chacune des introductions, voici un petit rappel.
Mais c’est quoi à la fin OData ?
OData est un protocole de manipulation de données basé sur http en REST. On peut filtrer, paginer, trier mais aussi modifier et supprimer ces données grâce à une simple URI (c’est à dire un “chemin web” comme ceux que vous saisissez dans la barre d’adresse de votre navigateur).
En simplifié:
- la question est une URI
- la réponse est un flux XML (Atom ou JSON)
Avantages et caractéristiques:
n’importe quelle plateforme supportant http pourra accéder à des données publiées en OData (= des plateformes très simples, sans avoir besoin d’installer de framework ou d’outil particulier)
grâce à http, le passage de firewalls se fera facilement
pour le développeur, l’utilisation de données accessibles par OData s’effectue plus ou moins facilement, selon que des SDK clients OData existent sur cette plateforme. Au pire, il faudra construire la demande (l’URI) soi-même et parser manuellement le flux de données Atom ou JSON (XML) en retour. Au mieux (et c’est certainement votre cas), un SDK client vous aidera en fournissant une API de plus haut niveau et en créant des classes proxy qui correspondent à la structure des données fournies par le flux Atom.
des SDK clients sont disponibles pour .NET, Silverlight, Windows Phone 7, PHP, AJAX, Javascript, Ruby, Objective C et Java
la liste non exhaustive des produits MS mettant à disposition des données via OData sont SharePoint 2010, Excel 2010 (via SQL Server PowerPivot for Excel), Windows Azure Storage, SQL Server 2008 R2.
Vous pouvez utiliser les services OData existants pour les intégrer dans vos applications
Microsoft WCF Data Services (anciennement Astoria) est le composant de .Net qui permet d’implémenter OData.
Exemple:
Un petit exemple sur un service OData https://odata.microsoftpdc.com/ODataSchedule.svc/ qui nous renseigne sur les évènements de la PDC 2010 :
La requête: https://odata.microsoftpdc.com/ODataSchedule.svc/ (vous pouvez la tester dans votre navigateur préféré)
Nous renvoie les éléments accessibles à la racine : collections de sessions, speakers, … :
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<service xml:base="https://odata.microsoftpdc.com/ODataSchedule.svc/" xmlns:atom="https://www.w3.org/2005/Atom" xmlns:app="https://www.w3.org/2007/app" xmlns="https://www.w3.org/2007/app">
<workspace>
<atom:title>Default</atom:title>
<collection href="ScheduleOfEvents">
<atom:title>ScheduleOfEvents</atom:title>
</collection>
<collection href="Sessions">
<atom:title>Sessions</atom:title>
</collection>
<collection href="Tracks">
<atom:title>Tracks</atom:title>
</collection>
<collection href="TimeSlots">
<atom:title>TimeSlots</atom:title>
</collection>
<collection href="Speakers">
<atom:title>Speakers</atom:title>
</collection>
<collection href="Manifests">
<atom:title>Manifests</atom:title>
</collection>
<collection href="Presenters">
<atom:title>Presenters</atom:title>
</collection>
<collection href="Contents">
<atom:title>Contents</atom:title>
</collection>
<collection href="RelatedSessions">
<atom:title>RelatedSessions</atom:title>
</collection>
</workspace>
</service>
Pour filtrer à la source, il suffit de suffixer le nom du service par l’arborescence nous amenant à un élément ou une collection d’éléments et d’y ajouter (ou pas) une requête (OrderBy, Take, Skip, …) et son prédicat.
Dans notre exemple, nous souhaitons consulter les 2 premiers speakers triés par ordre alphabétique.
La requête devient: https://odata.microsoftpdc.com/ODataSchedule.svc/Speakers/?$orderby=FullName&$top=2 (plus d’info sur les requêtes ici https://www.odata.org/developers/protocols/uri-conventions#QueryStringOptions)
Et renvoie: Adam Wilson et Amit Chopra
<?xml version="1.0" encoding="utf-8" standalone="yes" ?>
<feed xml:base="https://odata.microsoftpdc.com/ODataSchedule.svc/" xmlns:d="https://schemas.microsoft.com/ado/2007/08/dataservices" xmlns:m="https://schemas.microsoft.com/ado/2007/08/dataservices/metadata" xmlns="https://www.w3.org/2005/Atom">
<title type="text">Speakers</title>
<id>https://odata.microsoftpdc.com/ODataSchedule.svc/Speakers/</id>
<updated>2010-11-05T13:27:16Z</updated>
<link rel="self" title="Speakers" href="Speakers" />
<entry>
<id>https://odata.microsoftpdc.com/ODataSchedule.svc/Speakers(guid'7553a0ea-159f-452e-bb5e-a94edfb0cd9d')</id>
<title type="text" />
<updated>2010-11-05T13:27:16Z</updated>
<author>
<name />
</author>
<link rel="edit" title="Speaker" href="Speakers(guid'7553a0ea-159f-452e-bb5e-a94edfb0cd9d')" />
<category term="Shared.Model.Speaker" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.Guid">7553a0ea-159f-452e-bb5e-a94edfb0cd9d</d:Id>
<d:FullName>Adam Wilson</d:FullName>
<d:PhotoUrl m:null="true" />
<d:Bio m:null="true" />
</m:properties>
</content>
</entry>
<entry>
<id>https://odata.microsoftpdc.com/ODataSchedule.svc/Speakers(guid'758b9c4f-5b12-4ef2-8cf9-5e3652f5dd3e')</id>
<title type="text" />
<updated>2010-11-05T13:27:16Z</updated>
<author>
<name />
</author>
<link rel="edit" title="Speaker" href="Speakers(guid'758b9c4f-5b12-4ef2-8cf9-5e3652f5dd3e')" />
<category term="Shared.Model.Speaker" scheme="https://schemas.microsoft.com/ado/2007/08/dataservices/scheme" />
<content type="application/xml">
<m:properties>
<d:Id m:type="Edm.Guid">758b9c4f-5b12-4ef2-8cf9-5e3652f5dd3e</d:Id>
<d:FullName>Amit Chopra</d:FullName>
<d:PhotoUrl>https://pdccms.istreamplanet.com/content/AmitChopra.jpg</d:PhotoUrl>
<d:Bio>Amit Chopra is a Senior Program Manager with the Visual Studio Test and Lab Team which is responsible for creating the Visual Studio 2010 Test Professional Product and the Lab Management Features. Amit has spent over 10 year in the Developer Division working on variety of IDE Features targeted towards Office Developers, Windows Phone Developers and most recently on features aimed to enhance Developer / Test collaboration in teams that are using Visual Studio Team Foundation Server as the core ALM Platform. Prior to working for Microsoft, Amit has worked for companies such as PricewaterhouseCoopers, Sun Microsystem, CANON and DEC in various capacities in the engineering and developer evangelism groups.</d:Bio>
</m:properties>
</content>
</entry>
</feed>
L’introduction à OData s’arrête ici.
Pour aller plus loin :