tulosrajapintojen
Tulosrajapinnat ovat ohjelmistokehityksessä käytetty termi, jolla tarkoitetaan komponenttien ulospäin tuotettujen tulosten määrittelyyn tarkoitettua rajapintaa. Ne muodostavat sopimuksen siitä, miten yhden moduulin tai palvelun tuottamat tulokset ovat rakenteeltaan ja miten niitä kulutetaan seuraavissa kerroksissa, kuten käyttöliittymässä tai toisten palveluiden kanssa.
Tulosrajapinnat auttavat erottamaan liiketoimintalogikin ja esitystason sekä muotittamaan palautettavat tulokset selkeiksi ja ennustettaviksi. Niiden etuja ovat
Tulosrajapinnat tyypillisesti määrittelevät:
- tulosmallin tai vastauksen rakenteen (data-olio, tilatiedot kuten onnistunut/epäonnistunut)
- mahdolliset meta- ja lisätiedot (otsikot, sivutustiedot, aikaleima)
- virheiden käsittelyn ja virhekoodien kiinnipitoa sekä virheilmoitusten muotoa
- mahdolliset tilatiedot, kuten luokittelut tai koodit, joita kuluttaja voi käyttää
Suoritus- ja suunnittelumallit
Käytännössä tulosrajapinnat voivat toteutua esimerkiksi seuraavilla tavoilla:
- tulosmallin hakeminen tietomallina (DTO) tai presentaatio-muotona, jota käyttöliittymä kuluttaa
- samankaltaisten rajapintojen käyttö useissa palveluissa tai useiden toimintojen kesken
- virheenkäsittely, jossa on erillinen virhe- tai statuskoodi ja kuvaileva viesti
- pidä rajapinta selkeänä ja pienimuotoisena
- versionoi muutokset, jotta vanha toiminnallisuus säilyy
- minimoi riippuvuudet liiketoimintamuuttujista tulosmalliin
- dokumentoi odotetut vastaukset ja mahdolliset virheet
Tulosrajapinnat sijoittuvat usein sovelluksen arkkitehtuurin käyttöliittymän ja liiketoimintalogiikan rajapintaan, sekä toimivat kuin sopimus, jonka molemmat osapuolet—tuottava