hRESTS — a Microformat for RESTful Services

Published by Tomas  Vitvar on December 1, 2008 in Publications,Research

Our work on hRESTS, a microformat to describe RESTful services (co-authored by Jacek Kopecky, Karthik Gomadam and me) has been accepted to a Web Intelligence conference to be held in Sydney, Australia this year in December (the acceptance rate was around 18%). You can download the full paper here.

The value of today’s Web applications is no longer only in providing content to consumers but also in exposing functionality through public APIs designed for machine consumption. Typically, both Web applications and APIs today follow the Web architecture style called REST, and public APIs on the Web are often called “RESTful Web services”. The major problem with today’s RESTful APIs is that they are usually only described in a plain, unstructured HTML documentation useful only to a human developer. From this reason, finding suitable services, composing them (“mashing them up”), mediating between different data formats etc. are currently completely manual tasks.

hRESTS is a microformat for machine-readable descriptions of Web APIs, backed by a simple service model. In general, a microformat is an approach for annotating human-oriented Web pages so that key information is machine-readable. On top of microformats, GRDDL is a mechanism for extracting RDF information from Web pages, particularly suitable for processing microformats. There are already microformats for contact information, geographic coordinates, calendar events, etc.

Figure above depicts the model that the hRESTS uses for HTML annotation. It is derived from the fact that every web application using hyperlinks for linking application’s pages can be seen as a service. Obviously, not every web application can be considered as a RESTful service as it does not necessarily follow the REST architecture style. There are a lot of examples of badly designed RESTful architectures, such as here. We use RDF to represent the model that can be further extended with additional information such as WSMO-Lite service ontology (see my previous post and our paper about WSMO-Lite). In its basic form, the hRESTS annotation for a hotel service is shown below.

In order to extract the meta-data from the annotated HTML document using hRESTS, one needs to know the hRESTS annotation mechanism. For this purpose and in accordance with GRDDL we also provide a XSLT stylesheet that extracts the meta-data in RDF from XHTML pages. You can download the XSLT stylesheet here.

Once the hRESTS is used by RESTful service providers, one can easily build a focused search engine for RESTful services, for example by using Yahoo! BOSS web search in analogical way like BOSS web search can be used for e.g. searching LinkedIn public profiles annotated with hResume microformat. We further plan to submit the hRESTS microformat to as well as build extenisions towards semantic annotations which we call MicroWSMO.

2 Responses to “hRESTS — a Microformat for RESTful Services”

  1. Tantek says:

    hRESTS is a poshformat, not a microformat. See the poshformats page for more details.

  2. tomas says:

    Thanks for pointing this out. Yes, we have rather developed a poshformat and it was indeed our intention to follow the propoer microformat process with this.

Leave a Reply