Station

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

Metrokartta

Select a cycle, station, or stakeholder to open its permanent method page.

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

Selected station: Ratkaisu- ja rajapintasuunnittelu

Tarvittavat sidosryhmät

Liittyvät resurssit

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ä.

Tältä onnistuminen näyttää

Tarjoa uudelleenkäytettäviä suunnittelumalleja, yhteisiä standardeja ja validointityökaluja API-määrityksille. Varmista, että suunnittelupäätökset ovat johdonmukaisia, tarkistettuja varhaisessa vaiheessa ja linjassa liiketoiminnallisten tavoitteiden kanssa.

  1. Määrittele keskeiset oliot, niiden attribuutit ja suhteet yhteisen käsitteellisen ymmärryksen luomiseksi eri rajapinnoille. — Toimialuekanvas
  2. Määrittele Interaction Canvasin avulla, miten hyödyntäjät ovat vuorovaikutuksessa APIn kanssa, ja Varmistetaan, että se vastaa heidän tarpeitaan ja odotuksiaan. — Vuorovaikutuskanvas
  3. Sovellat REST-suunnittelumalleja luodaksesi johdonmukaisia, uudelleenkäytettäviä API-sopimuksia, jotka validoidaan sidosryhmien kanssa. — REST-kanvas
  4. Sovellat tapahtumapohjaisia suunnittelumalleja luodaksesi johdonmukaisia, uudelleenkäytettäviä API-sopimuksia, jotka validoidaan sidosryhmien kanssa. — Tapahtumakanvas
  5. Sovellat GraphQL-suunnittelumalleja luodaksesi johdonmukaisia, uudelleenkäytettäviä API-sopimuksia, jotka validoidaan sidosryhmien kanssa.
  6. Käytä suunnitteluperiaatteita ja API-tyyliohjetta, jotta suunnittelupäätöksesi ovat linjassa yhteisten sääntöjen kanssa ja mahdollistavat johdonmukaisen auditoinnin ja validoinnin. — API-suunnitteluperiaatteet
  7. Varmistetaan API-auditoinnin tarkistuslistan avulla, että API-suunnittelu täyttää toiminnalliset ja muut kuin toiminnalliset vaatimukset, mukaan lukien tietoturva, suorituskyky ja vaatimustenmukaisuus.
  8. Käytä API-tarkastuslistaa varmistaaksesi, että API-suunnittelu täyttää toiminnalliset ja ei-toiminnalliset vaatimukset, mukaan lukien turvallisuus, suorituskyky ja vaatimustenmukaisuus. — API-auditoinnin tarkistuslista

Metro lines

API-suunnittelulinja

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

Liittyvät resurssit

Browse the resources selected for API-suunnittelu; the summary above explains how they support this station’s work.

Resurssit

Resources for API-suunnittelu

canvas

Vuorovaikutuskanvas

Määrittele API-vuorovaikutukset, työnkulut ja odotetut vastaukset, jotta varmistetaan yhdenmukainen API-kokemus.

Tulokset

  • Valitun kyvykkyyden määritelty vuorovaikutusmalli
  • Selkeytetyt syötteet, tuotokset, komennot, kyselyt, tapahtumat ja vastaukset
  • Sovitut validointisäännöt ja vuorovaikutusodotukset

Näin se toimii

  1. Kartoita rajapinnan vuorovaikutukset käyttäjän tehtäviin.
  2. Määritä päätepisteet kullekin vuorovaikutukselle
  3. Dokumentoi kunkin vuorovaikutuksen syötteet ja tuotokset.
  4. Validointisääntöjen ja -rajoitusten määrittäminen
  5. Luo vuorovaikutusmalleja CRUD-, kysely-, komento- ja tapahtumapohjaista vuorovaikutusta varten.

Relevant cycles

Kyvykkyyden tuotteistamisen sykli

Sykli liiketoiminnan kyvykkyyksien muuttamiseen uudelleenkäytettäviksi digitaalisiksi kyvykkyyksiksi ennen toteutustavan valintaa.

API-tuotteistamisen sykli

API-keskeinen APIOps Cycles -polku APIen tuotteistamiseen, suunnitteluun, toimittamiseen, julkaisuun ja parantamiseen.

Automaatiosykli

Sykli automaatiomahdollisuuksien tunnistamiseen, suunnitteluun, toimittamiseen, käyttöönoton mahdollistamiseen ja parantamiseen.