Suunnittele ohjelmointirajapinnan rakenne

Kun tietomalli on valmis, sen perusteella voidaan luonnostella yksi tai useampi ohjelmointirajapinta. Ohjelmointirajapinnan luonnos voi kattaa yksinkertaisen tietomallin kokonaan tai osia monimutkaisemmasta mallista.

API ensin (API First) on kehitysstrategia, jossa ohjelmointirajapinta (API) suunnitellaan ennen varsinaista ohjelmointityötä. Tämä varmistaa, että ohjelmointirajapinta on koko tietojärjestelmän perusta, jolloin muut osat rakentuvat sen ympärille. Selkeä määrittely alussa helpottaa tietojärjestelmien yhteentoimivuutta ja mahdollistaa eri kehitystiimien rinnakkaisen työskentelyn määrittelyn jälkeisessä toteutusvaiheessa.

API ensin -malli on hyödyllinen erityisesti monimutkaisissa hankinnoissa, sillä se jakaa kokonaisuuden hallittaviin osiin. Näin eri tiimit voivat kehittää omia osiaan samanaikaisesti.

API ensin -mallin hyötyjä:

• Yhteentoimivuus: Ohjelmointirajapinta määritellään ensin, mikä helpottaa tietojärjestelmien välistä yhteistyötä.
• Ketterä kehitys: Tiimit voivat työskennellä samanaikaisesti, mikä nopeuttaa projektin etenemistä.
• Skalautuvuus: Tietojärjestelmät on helpompi laajentaa ja ylläpitää.

Toimintatapaa kutsutaan myös nimellä ”tekemistä vaille valmis” -lähestymistavaksi, koska ohjelmointirajapinnan luonnoksen avulla voi kerätä palautetta jo ennen varsinaista ohjelmointityötä. Organisaation sisäiset ja ulkoiset sidosryhmät voivat kommentoida rajapintakuvauksia.

Monet ohjelmointirajapintojen hallintaan tarkoitetut ilmaiset ja kaupalliset työkalut on suunniteltu tukemaan API ensin -mallia, mikä tekee sen toteuttamisesta helppoa. Useimpien työkalujen avulla voi luoda merkittävän osan ohjelman koodista automaattisesti ohjelmointirajapinnan kuvauksen perusteella, mikä pienentää merkittävästi jäljelle jäävää ohjelmointityötä. Samalla virheiden määrä vähenee.

Kun hankinta tehdään vain yhden organisaation käyttöön, ohjelmointirajapinnat voivat unohtua. Hankintavaiheessa ei välttämättä ymmärretä tarvetta siirtää tietoa tietojärjestelmästä sisään ja ulos.

Valmisohjelmiston avaimet käteen -toimitus voi sisältää kaiken muun paitsi rajapinnat, joita tarvitaan tulevaisuudessa työn tehokkuuden ja tuottavuuden kehittämiseen. Ohjelmiston tietomallit voivat olla myös teollisoikeuksin suojattuja, jolloin ohjelmointirajapinnan lisääminen voi olla kallista tai jopa mahdotonta.

API ensin -mallin vastakohtana on tarpeen tullen -malli, jossa ohjelmointirajapinnat toteutetaan vasta, kun niitä tarvitaan. Jos ohjelmointirajapintojen merkitystä ei ymmärretä alusta alkaen, niiden toteutusta vältellään ja ne nähdään vain teknisinä ratkaisuina.

Tarpeen tullen -mallin heikkouksia ovat

• Kehitystyön ja ohjelmointirajapinnan tuoma ketteryys menetetään.
• Jatkokehitystä ja -kilpailutusta on vaikeampi toteuttaa.
• Johtaa helposti ylimääräiseen työhön ja väliaikaisratkaisujen käyttöön.

Lue lisää: Julkisen hallinnon API-periaatteiden arvo ja merkitys suomalaisten julkisten organisaatioiden näkökulmasta (Alila, Tampere university, 2023).Avautuu uuteen ikkunaan.