API-First Design with Modern Tools

Abstract

Business strategies that aim to benefit from APIs are rapidly becoming more common in the IT industry. Well-designed and implemented APIs are an important step towards successful API economy, and for this reason the assigner of the thesis was interested in an API design strategy called API-first design. The objective of the thesis was to research how to apply API-first design in practice and what kind of benefits does it offer, and also to test this method to find out an effective way of using it in Microsoft Azure environment. Different tools and standards dedicated to API design were expected to make API-first design more efficient. The research method used was design research, where the API-first process was tested iteratively to evaluate how different tools and standards were able to support this process with Azure API Management service. The result of the thesis was a working API-first process in Azure environment that uses OpenAPI 2.0 standard and the tools Swagger Editor and Swagger Codegen. The research concluded that API-first design is a beneficial method to be used in Azure environment, and that tools and standards can support this process very well by making the development faster and more precise and making it easier to start applying this design method.

Ohjelmistorajapintoja hyödyntävät API-talouteen kuuluvat liiketoimintastrategiat tulevat jatkuvasti yleisemmiksi ohjelmistoalalla. Hyvin suunnitellut ja toteutetut rajapinnat ovat tärkeä askel kohti onnistunutta API-taloutta, minkä vuoksi opinnäytetyön toimeksiantaja oli kiinnostunut rajapintojen suunnittelutekniikka rajapintalähtöisestä sovelluskehityksestä. Tutkimuksen tavoitteena oli selvittää, kuinka rajapintalähtöistä sovelluskehitystä voidaan toteuttaa käytännössä ja mitä hyötyjä siitä on, sekä löytää tehokas tapa käyttää sitä Microsoft Azure ympäristössä. Erilaisten rajapintojen kehittämiseen tarkoitettujen työkalujen ja standardien odotettiin tehostavan rajapintalähtöistä kehitystä. Tutkimus toteutettiin kehittämistutkimuksena, jossa rajapintalähtöistä sovelluskehitysprosessia testattiin iteratiivisesti arvioiden, kuinka eri työkalut ja standardit pystyvät tukemaan tätä prosessia Azure API Management palvelun kanssa. Opinnäytetyön tulos oli toimiva rajapintalähtöinen sovelluskehitysprosessi, joka käyttää OpenAPI 2.0 standardia sekä Swagger Editor ja Swagger Codegen työkaluja. Tutkimus osoitti, että rajapintalähtöinen sovelluskehitys on hyödyllinen suunnittelutekniikka käyttää Azure ympäristössä ja että työkalujen käyttö rajapintalähtöisessä kehitysprosessissa tukee sitä erinomaisesti tehden siitä nopeamman ja tarkemman, sekä helpottaen tekniikan käyttöönottoa.