API-design

Luo harkittuja API-designeja, jotka vastaavat käyttäjien tarpeita, tuotetavoitteita ja johdonmukaisia määrityksiä.

Tulokset

• Hyvin dokumentoidut ja johdonmukaiset API-mallit

Liittyvät metrolinjat

• API-suunnittelulinja

Miksi sillä on merkitystä

API-designissa ei ole kyse vain päätepisteiden nimeämisestä. Hyvällä suunnittelulla varmistetaan, että rajapinnat ovat käyttökelpoisia, johdonmukaisia ja linjassa liiketoiminnallisten ja teknisten tavoitteiden kanssa. Huonosti suunnitellut rajapinnat aiheuttavat teknistä velkaa, heikkoa hyväksyntää ja uudelleentyöstämistä tiimeissä.

Pääsykriteerit

• API-arkkitehtuuri käyttää uudelleenkäytettävyyttä ja integrointia edistäviä malleja, ja se on vahvistettu sidosryhmien kanssa.
• APIn tavoitteena on piilottaa taustalla olevat tietomallit ja eroavaisuudet.
• APIn suunnittelu ja päätepisteet ovat selkeästi yhteydessä niiden liiketoiminnalliseen arvoon ja ominaisuuksiin.
• APIn suunnittelu on yhdenmukainen muiden API-tuotteidemme kanssa.

Poistumiskriteerit

• API-arkkitehtuuri käyttää uudelleenkäytettävyyttä ja integrointia edistäviä malleja, ja se on vahvistettu sidosryhmien kanssa.
• APIn tavoitteena on piilottaa taustalla olevat tietomallit ja eroavaisuudet.
• APIn suunnittelu ja päätepisteet ovat selkeästi yhteydessä niiden liiketoiminnalliseen arvoon ja ominaisuuksiin.
• APIn suunnittelu on yhdenmukainen muiden API-tuotteidemme kanssa.

Näin se toimii

1. Määrittele keskeiset oliot, niiden attribuutit ja suhteet yhteisen käsitteellisen ymmärryksen luomiseksi eri sovellusliittymille.
   Domain Canvas Mallinnustyökalu, jolla määritellään ja välitetään toimialueesi keskeiset entiteetit ja suhteet ja varmistetaan semanttinen yhdenmukaisuus eri sovellusrajapinnoissa.
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.
   Interaction Canvas Määrittele API-vuorovaikutukset, työnkulut ja odotetut vastaukset, jotta varmistetaan yhdenmukainen API-kokemus.
3. Sovellat REST-suunnittelumalleja luodaksesi johdonmukaisia, uudelleenkäytettäviä API-sopimuksia, jotka validoidaan sidosryhmien kanssa.
   REST Canvas Suunnittele sovellusrajapinnat RESTful-periaatteiden mukaisesti määrittelemällä resurssit, verbit sekä esimerkkipyynnöt ja -vastaukset.
4. Sovellat tapahtumapohjaisia suunnittelumalleja luodaksesi johdonmukaisia, uudelleenkäytettäviä API-sopimuksia, jotka validoidaan sidosryhmien kanssa.
   Event Canvas Suunnittele tapahtumapohjaisia sovellusliittymiä määrittelemällä tapahtumia, laukaisimia ja käsittelylogiikkaa.
5. Sovellat GraphQL-suunnittelumalleja luodaksesi johdonmukaisia, uudelleenkäytettäviä API-sopimuksia, jotka validoidaan sidosryhmien kanssa.
   GraphQL Canvas Suunnittele GraphQL APIt määrittelemällä tyypit, kyselyt, mutaatiot ja tilaukset.
6. Suunnittele kuluttajien tarpeita vastaavat rajapinnat ja Varmistetaan, että ne ovat löydettävissä, ymmärrettäviä ja käyttökelpoisia.
   APIn suunnitteluperiaatteet Tiivis opas APIn käytettävyyteen, löydettävyyteen ja johdonmukaisuuteen, joka perustuu todistettuihin suunnittelufilosofioihin ja käyttäjien tarpeisiin.
7. Varmistetaan API-auditoinnin tarkistuslistan avulla, että API-suunnittelu täyttää toiminnalliset ja muut kuin toiminnalliset vaatimukset, mukaan lukien tietoturva, suorituskyky ja vaatimustenmukaisuus.
   API-auditoinnin tarkistuslista Kattava tarkistuslista API-valmiuden tarkistamiseksi ennen julkaisemista, joka kattaa suunnittelun, dokumentoinnin, tietoturvan ja käytäntöjen noudattamisen.

Sovella työssäsi

Tarjotaan uudelleenkäytettäviä malleja, standardeja ja validointityökaluja API-määrityksiä varten. Varmistetaan, että tiimit noudattavat suunnittelukatselmuksia ja ottavat palautteen huomioon varhaisessa vaiheessa.