Suomi.fi kehittäjille
Siirry suoraan sisältöön.
Hyvät käytännöt kehittäjille
Ohjelmointirajapintojen suunnittelu julkisessa hallinnossa

Kehittämisen aikana

Rakenna ohjelmointirajapintoja ketterästi: kehitä niitä pienissä osissa ja aloita tärkeimmästä.

Suunnittele avoin tietomalli sääntelyn ja toimintaympäristön pohjalta. Huomioi mallissa myös kansainvälinen yhteentoimivuus.

Kehitä ohjelmointirajapinnan luonnokset tietomallin pohjalta ja API ensin -mallin avulla. Suunnittele luonnokset yhdessä oleellisten sidosryhmien kanssa.

Sovella arkkitehtuurityyliä monipuolisesti, asiakaskeskeisesti ja arvoa jäsentäen.

Suunnittele asiakaslähtöisesti ja huomioi ohjelmointirajapinnan hyödyntäjien näkökulmat.

Rakenna ohjelmointirajapinnan ominaisuuksiin automaattinen yksikkötestaus, laadukas integraatiotestaus ja suunnittele kattava suorituskykytestaus.

Suojaa ohjelmointirajapinnan kautta käsiteltävät henkilötiedot. Tietoturvan tärkeimpiä tavoitteita ovat esimerkiksi tiedon luottamuksellisuus, eheys ja saatavuus.

Sanasto