Viestipalvelun tuottaminen ja dokumentointi

Abstract

Opinnäytetyö toteutettiin yhteistyössä Protacon Solutions Oy:n kanssa. Tavoitteena oli kehittää yrityksen käyttöön mahdollisimman yleiskäyttöinen ja helposti käyttöönotettava viestipalvelu, joka toisi yritykselle lisäarvoa abstraktoimalla yleisen sovelluskomponentin yksittäisten sovellusten ulkopuolelle.

Viestipalvelu toteutettiin yhdistellen REST- ja MQ-rajapintoja, käyttäen hyväksi kahta eri ohjelmointikieltä, Pythonia sekä PHP:tä ja niille kehitettyjä sovelluskehyksiä ja kirjastoja. Viestijonona sovelluksessa käytettiin sovelluksen kanssa samalle palvelimelle asennettua RabbitMQ-instanssia. Viestipalvelun dokumentointi toteutettiin ulospäin näkyvään REST- rajapintaan Swagger-dokumentointityökalun avulla.

Opinnäytetyön tuloksena saatiin kehitettyä toimiva konseptitasoinen sovellus ja todistettua se, että valituilla menetelmillä voidaan luoda halutunlainen yleiskäyttöinen viestipalvelu. Viestipalvelun dokumentointi saatiin myös toteutettua niin, että sovellusta tuntemattomienkin kehittäjien olisi helppo ottaa se käyttöön. Havaittiin myös, että kattava dokumentointi on tärkeä kulmakivi pohdittaessa käyttöönottoa helpottavia yksityiskohtia.

Toteutusta jälkikäteen tarkastellessa todettiin, että sekä REST- että MQ-rajapinnoille on paikkansa modernissa sovelluskehityksessä. Lisäksi selkeiden sovelluskomponenttien kuten viestien lähettämisen irrottaminen yksittäisistä sovelluksista yleiskäyttöiseksi palveluksi todettiin toimivaksi ratkaisuksi.

The bachelor’s thesis was assigned by Protacon Solutions Oy. The goal was to develop a generic and easy-to-use messaging service for the company. The finished service was meant to help abstract generic application functions in to a separate layer so that the functionality would rather be implemented to new software via API calls than have to be done over and over again.

The used techniques consisted of both REST and message queues and were developed with two different programming languages, Python and PHP. In addition to the selected languages, external libraries such as Flask were used. Message queue of choice was widely used RabbitMQ, which was installed as a unique instance on the developed application’s server. The documentation of the service was generated via Swagger, a tool specifically developed for the job.

As a result of the thesis, a simple and working message service was developed. The chosen techniques worked together well, and the documentation came out clear and descriptive. The level of the interactive documentation should be more than enough to help new developers to start using the service in their own applications.

While evaluating the application and development process, it was clarified that both REST and message queues have their own place in the modern software development. Also, extracting the generic components to services was found out to be a solid way of developing web applications.