KukaEi valittuMiksiEi valittuMissäAPI-suunnitteluSykliAPI-tuotteistamisen sykliAPI-suunnittelulinja

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.

StrateginenHallintaKäyttäjäTekninenKäyttäjäkokemusKäyttäjäkokemusMarkkinatietoaMarkkinatietoaLiiketoiminnalliset tavoitteetLiiketoiminnalliset tavoitteetKilpailuanalyysiKilpailuanalyysiEkosysteemin visioEkosysteemin visioSkaalautuva infrastruktuuriSkaalautuva infrastruktuuriLainsäädäntö ja vaatimustenmukaisuusLainsäädäntö ja vaatimustenmukaisuusTietoturva ja yksityisyysTietoturva ja yksityisyysSuunnittelustandarditSuunnittelustandarditToimittajan hallintaToimittajan hallintaSopimussuunnitteluSopimussuunnitteluKehitysKehitysCI/CDCI/CDTestausautomaatioTestausautomaatioJulkaisunhallintaJulkaisunhallintaPalvelusopimuksetPalvelusopimuksetAPIn käyttöönottoAPIn käyttöönottoAPI-näkyvyysAPI-näkyvyysKumppanien integrointiKumppanien integrointiAPI-ajattelutapaAPI-ajattelutapaRoolit ja vastuualueetRoolit ja vastuualueetOsaamisen kehittäminenOsaamisen kehittäminenToimintaohjeetToimintaohjeetPortfolionhallintaPortfolionhallintaBudjetin ja resurssien hallintaBudjetin ja resurssien hallintaStrategia1API-tuotestrategiaHyödyntäjien vaatimukset ja käyttöönotto2API-hyödyntäjäkokemusArkkitehtuuri- ja alustapäätökset3API-alustanarkkitehtuuriRatkaisu- ja rajapintasuunnittelu4API-suunnitteluToimitus ja operointi5API-toteutusLaadun ja valmiuden varmistus6API-auditointiJulkaisu ja käyttöönoton mahdollistaminen7API-julkaisuSeuranta ja parantaminen8APIen seuranta japarantaminenLiiketoimintamahdollisuuksien linjaAlusta-arkkitehtuurilinjaAPI-suunnittelulinjaToimituslinjaJulkaisu- ja käyttöönoton linjaToimintamallilinja

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

canvasVuorovaikutuskanvasMäärittele API-vuorovaikutukset, työnkulut ja odotetut vastaukset, jotta varmistetaan yhdenmukainen API-kokemus.
Katso lisätiedot ja muokkaa täälläAvaa CanvasCreatorissa
canvasREST-kanvasSuunnittele rajapinnat RESTful-periaatteiden mukaisesti määrittelemällä resurssit, verbit sekä esimerkkipyynnöt ja -vastaukset.
Katso lisätiedot ja muokkaa täälläAvaa CanvasCreatorissa
canvasTapahtumakanvasSuunnittele tapahtumapohjaiset rajapinnat ja integraatiot määrittelemällä tapahtumat, laukaisimet, skeemat, tuottajat, hyödyntäjät ja käsittelylogiikka.
Katso lisätiedot ja muokkaa täälläAvaa CanvasCreatorissa
guidelineAPI-suunnitteluperiaatteetTiivis opas APIn käytettävyyteen, löydettävyyteen ja johdonmukaisuuteen, joka perustuu yhteisiin suunnittelusääntöihin ja todellisiin hyödyntäjien tarpeisiin.
canvasToimialuekanvasMallinnustyökalu toimialueen keskeisten käsitteiden, entiteettien, suhteiden ja sääntöjen määrittelyyn, jotta kyvykkyydet, rajapinnat ja integraatiot pysyvät semanttisesti yhdenmukaisina.
Katso lisätiedot ja muokkaa täälläAvaa CanvasCreatorissa

Metrolinjat

API-suunnittelulinja

Keskittyy rajapintojen ja integraatioratkaisujen suunnitteluperiaatteisiin ja -käytäntöihin.

Use these decks to introduce the method or discuss it with your team. View online or download PowerPoint and PDF.