Keskittyy rajapintojen ja integraatioratkaisujen suunnitteluperiaatteisiin ja -käytäntöihin.
Asema
API-suunnittelu
Luo API-suunnitelmia, jotka ovat johdonmukaisia, uudelleenkäytettäviä ja perustuvat liiketoiminnallisiin tavoitteisiin sekä yhteisiin standardeihin.
APIen suunnittelu ei tarkoita pelkästään päätepisteiden (endpoints) nimeämistä. Hyvä suunnittelu varmistaa, että APIt ovat käyttökelpoisia, johdonmukaisia ja linjassa liiketoiminnallisten ja teknisten tavoitteiden kanssa. Huono suunnittelu johtaa tiukkoihin riippuvuuksiin, heikkoon uudelleenkäytettävyyteen ja kalliiseen uudelleen toteutukseen eri tiimien välillä.
Reittisi kartalla
Navigoi menetelmässä
Valitse asema, sykli tai sidosryhmän näkökulma tutustuaksesi menetelmään.
Tulokset
- Hyvin dokumentoidut ja johdonmukaiset API-mallit
- Uudelleenkäytettävät ja validoidut API-sopimukset
- Toimialamallien ja vuorovaikutusmallien mukaiset mallit
- Suunnittelun jäljitettävyys liiketoiminnan arvoon
Matkan kriteerit
Aloituskriteerit
- Kyvykkyys vastaa selkeään liiketoimintatarpeeseen ja on uudelleenkäytettävissä tarkoitetuille hyödyntäjille.
- Valittu rajapinta tarjoaa hyödyntäjille sopivan abstraktion.
- Kyvykkyyden arvolupaus on validoitu liiketoiminnan ja hyödyntäjien sidosryhmien kanssa.
- Hyödyntäjäsegmentit on tunnistettu.
- Ylätason toteutuksen etenemissuunnitelma on määritelty.
Valmistumiskriteerit
- Valittu arkkitehtuuri, alusta ja toteutustapa on validoitu olennaisten arkkitehtuuri-, tietoturva- ja alustasidosryhmien kanssa.
- Valittu rajapinta tarjoaa hyödyntäjille sopivan abstraktion.
- Rajapintasuunnittelu ja tarjottavat kyvykkyydet ovat jäljitettävissä liiketoiminta-arvoon ja hyödyntäjien tarpeisiin.
- Rajapintasuunnittelu noudattaa sovittuja suunnittelustandardeja ja käytäntöjä.
Tarvittavat sidosryhmät
Liittyvät resurssit
VuorovaikutuskanvasMäärittele API-vuorovaikutukset, työnkulut ja odotetut vastaukset, jotta varmistetaan yhdenmukainen API-kokemus.REST-kanvasSuunnittele rajapinnat RESTful-periaatteiden mukaisesti määrittelemällä resurssit, verbit sekä esimerkkipyynnöt ja -vastaukset.TapahtumakanvasSuunnittele tapahtumapohjaiset rajapinnat ja integraatiot määrittelemällä tapahtumat, laukaisimet, skeemat, tuottajat, hyödyntäjät ja käsittelylogiikka.API-auditoinnin tarkistuslistaElinkaaripohjainen tarkistuslista, jolla varmistetaan APIn valmius suunnittelun, toimituksen, julkaisun ja vaatimustenmukaisuuden osalta määriteltyjen auditointikriteerien ja todisteiden avulla.API-suunnitteluperiaatteetTiivis opas APIn käytettävyyteen, löydettävyyteen ja johdonmukaisuuteen, joka perustuu yhteisiin suunnittelusääntöihin ja todellisiin hyödyntäjien tarpeisiin.ToimialuekanvasMallinnustyökalu toimialueen keskeisten käsitteiden, entiteettien, suhteiden ja sääntöjen määrittelyyn, jotta kyvykkyydet, rajapinnat ja integraatiot pysyvät semanttisesti yhdenmukaisina.