Introducing REST Based API Management and Its Relationship to Existing SOAP Based Systems

Abstract

API:en (Application Programming Interfaces, ohjelmointirajapinta) merkitystä ei voi liioitella, sillä esteettömät API:t muuttavat maailmaa. Samaan aikaan teknologinen megatrendi on siirtymässä SOAP:sta yhä enemmän kohti HTTP/JSON RESTful API-ratkaisuja.

Yritys X on keskikokoinen yritys, joka tarjoaa laajan valikoiman ratkaisuja pankki-, varainhoito-, vakuutus- ja kiinteistöalalla. Tällä hetkellä yrityksen X taustajärjestelmät tarjoavat enimmäkseen SOAP-palveluja.

Tämä tutkimus on konseptitodistus, joka havainnollistaa mahdollisuutta tarjota olemassa olevat SOAP-palvelut REST-palveluina ja käyttää API-hallinta-alustaa olemassa olevien API-palveluiden ja niiden kuluttajien seuraamiseen ja hallintaan. Yritys X:ssä käytössä oleva Oracle Service Bus:n 12c-versio mahdollistaa SOAP-pohjaisten ratkaisujen tarjoamisen REST-pohjaisina, mitä hyödynnettiin kehityksen aikana.

Tutkimuksen aikana kehitettiin useita osia: Oracle Service Bus (OSB) -palvelu SOAP-pohjaisesti, API-sovellus sisältäen SOAP-REST- ja REST-REST-adapterit. Myös palveluntarjoaja ja kuluttaja (palvelua käyttävän sovelluksen konfiguraatio) lisättiin KONG API -hallintajärjestelmään.

The importance of web APIs (Application Programming Interfaces) in general cannot be exaggerated — accessible APIs are changing the world. At the same time the technological megatrend is moving from SOAP and increasingly towards HTTP/JSON RESTful APIs.

Company X is a middle-sized financial institute which offers a broad range of solutions in banking, asset management, insurance and real estate. At the moment Company X’s backend systems provide mostly SOAP.

This research is a proof of concept illustrating the possibility of exposing existing SOAP services as REST services and using an API management platform for keeping track of the existing APIs and their consumers. Oracle Service Bus 12c, which is used in Company X, has a feature for exposing SOAP-based pipelines as REST which was utilized during the development.

During the research several parts were developed: an Oracle Service Bus (OSB) service with a SOAP based pipeline, an API application including SOAP-REST and REST-REST adapters, also a service provider and a consumer (configuration of the application that is using the service) were added to KONG API management system.