REST-pohjaisen web-rajapinnan kehittäminen

Abstract

Tässä työssä perehdyttiin REST-arkkitehtuurityyliin ja sen soveltamismahdollisuuksiin http-protokollaa hyödyntävissä web-rajapinnoissa. Käytännön vertailukohteena toimi Taloussanomien iOS-sovelluksen käyttöön tarkoitettu web-rajapinta. Työssä selvitettiin, kuinka hyvin Taloussanomien nykyinen web-rajapinta vastaa REST-arkkitehtuurityyliä ja mitä asioita pitäisi huomioida rajapinnan kehityksessä. Samalla Taloussanomien web-rajapintaan toteutettiin tuki maksulliselle uutispalvelulle.

REST-käsitteen merkityksestä vallitsee yleinen epätietoisuus. Yleinen käsitys tuntuu ole-van, että REST liittyy jotenkin web-rajapintoihin ja että se on kovassa nosteessa nykyaikana. Todellisuudessa REST on kuitenkin yleinen ohjelmistoarkkitehtuurityyli, jota on sovellettu Webin kehityksessä jo sen alkuajoilta asti. Periaatteessa kaiken webin sisällön tulisi noudattaa REST-periaatteita, myös web-rajapintojen. Käytännössä REST-periaatteista on kuitenkin luistettu useissa tapauksissa.

Tämän työn tarkoituksena oli hahmottaa tarkemmin REST-käsitteen merkitystä erityisesti web-rajapintakehityksessä. Erityisenä kiinnostuksen kohteena oli selvittää, missä tapauksissa on oleellista noudattaa REST-periaatteita. Työssä käytiin läpi vallitsevia käsityksiä erilaisista tavoista toteuttaa web-rajapintoja ja selvitettiin, miten nämä eri tavat sijoittuvat suhteessa REST:iin.

Tutkimustyön tuloksena selvisi, että REST-arkkitehtuurityyli tarjoaa monia etuja web-rajapintojen kehityksessä ja sitä kannattaa yleensä noudattaa ainakin jossain määrin. REST-periaatteita kunnioittaen on mahdollista toteuttaa monipuolisia web-rajapintoja, mutta tämä vaatii usein tarkkaa aiheeseen perehtymistä ja ajattelumallin muuttamista palvelukeskeisistä arkkitehtuureista resurssikeskeiseen arkkitehtuuriin. Usein paras vaihtoehto on jonkinlainen kompromissi, jossa otetaan käyttöön REST:n hyvät ominaisuudet niiltä osin, kuin ne on saavutettavissa ilman liikaa vaivannäköä. Tämä toteutui Taloussanomien web-rajapinnan kehityksessä.

The main goal of this Thesis was to gain more knowledge on Representational State Transfer (REST) based web API design. This knowledge was then used to evaluate to what extent the Taloussanomat Web API follows the REST architectural style and whether there is some ways to improve the RESTfulness of the API. Taloussanomat Web API was built for Taloussanomat iOS application to serve as a gateway to news articles and customer databases.

The major part of this Thesis concentrates on defining the main concepts behind the REST architectural style and web APIs. After getting a good grip on REST I proceed on studying the Hypertext Transfer Protocol (HTTP) and Uniform Resource Identifiers (URI), the two specifications that define the generic interface used by all component interactions on the Web. After getting the ground work done I was able to define Web APIs as “APIs for web based machine-to-machine interaction” as opposed to Web APIs used in human-to-machine interactions, which contains all the web applications used by web browsers.

After clearing up the basic vocabulary involved in Web API design I started to gather information on different approaches to Web API design and was able to narrow Web APIs in two basic categories: REST and Remote Procedure Call (RPC). As a rough characterization REST is the preferred way of developing Web APIs as it's the architectural style specifically designed for the web whereas RPC is a way to abstract remote communication to work like local communication by forgetting and not dealing with all the pitfalls of remote communication.

Finally I go through the Taloussanomat Web API in detail and resolve that although some of the principles of REST based Web APIs have been ignored in developing the Taloussanomat API it is still fairly RESTful and the compromises done where justified in order to produce a practical Web API for its purpose.