Station

API-auditointi

Varmista, että APIt täyttävät liiketoiminta-, suunnittelu- ja toimintastandardit ennen julkaisua ja käyttöönottoa.

APIt ovat pitkäikäisiä tuotteita, ja niiden on täytettävä laatu-, johdonmukaisuus- ja vaatimustenmukaisuusodotukset. Auditointi yhdistää suunnittelupäätökset, toteutuksen ja toimintavalmiuden määriteltyihin standardeihin, mikä vähentää riskejä ennen käyttöönottoa.

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: Laadun ja valmiuden varmistus

Tarvittavat sidosryhmät

Liittyvät resurssit

Tulokset

  • APIt täyttävät sisäiset ja ulkoiset standardit
  • Selkeä dokumentaatio API-suunnittelusta ja toteutuspäätöksistä
  • Turvallisuus, suorituskyky ja vaatimustenmukaisuus validoitu
  • Tuotannossa ilmenevien ongelmien riskin pienentäminen

Matkan kriteerit

Aloituskriteerit

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

Valmistumiskriteerit

  • Valittu arkkitehtuuri, alusta ja toteutustapa on validoitu olennaisten arkkitehtuuri-, tietoturva- ja alustasidosryhmien kanssa.
  • Rajapintasuunnittelu ja tarjottavat kyvykkyydet ovat jäljitettävissä liiketoiminta-arvoon ja hyödyntäjien tarpeisiin.
  • Rajapinta ja sen kyvykkyydet on dokumentoitu riittävän selkeästi katselmointia, auditointia ja käyttöönottoa varten.
  • Rajapintasuunnittelu noudattaa sovittuja suunnittelustandardeja ja käytäntöjä.
  • Rajapintasopimus on validoitu ja testattu toiminnallisia ja ei-toiminnallisia vaatimuksia vasten.

Tältä onnistuminen näyttää

Luo johdonmukainen auditointiprosessi, joka arvioi APIn valmiutta elinkaaren eri vaiheissa määriteltyjen kriteerien, todisteiden ja standardien avulla. Varmista, että puutteet tunnistetaan varhaisessa vaiheessa ja korjataan ennen julkaisua.

  1. Suorita tarkastuksia varmistaaksesi, että rajapinnat täyttävät organisatoriset, tekniset ja oikeudelliset standardit ennen julkaisemista. — API-auditoinnin tarkistuslista
  2. Käytä tarkistuslistoja, automatisoituja tarkistustyökaluja eli linttereitä ja testausvälineitä varmistaaksesi johdonmukaisuuden ja standardien noudattamisen.
  3. Tee yhteistyötä hallintotiimien ja toimialan asiantuntijoiden kanssa varmistaaksesi, että rajapinnat ovat valmiita tuotantoon.

Metro lines

API-suunnittelulinja

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

Liittyvät resurssit

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

Resurssit

Resources for API-auditointi

checklist

API-auditoinnin tarkistuslista

Elinkaaripohjainen tarkistuslista, jolla varmistetaan APIn valmius suunnittelun, toimituksen, julkaisun ja vaatimustenmukaisuuden osalta määriteltyjen auditointikriteerien ja todisteiden avulla.

Tulokset

  • Yhteinen ymmärrys resurssin API-auditoinnin tarkistuslista tarkoituksesta ja käytöstä
  • Johdonmukainen tapa soveltaa resurssia API-auditoinnin tarkistuslista
  • Asiaan liittyvien käytäntöjen parempi soveltaminen

Näin se toimii

  1. Varmista API-auditoinnin tarkistuslistan avulla, että API-design täyttää toiminnalliset ja muut kuin toiminnalliset vaatimukset, mukaan lukien tietoturva, suorituskyky ja vaatimustenmukaisuus.
  2. Suorita auditointeja elinkaaren kattavuuden arvioimiseksi ja varmista, että API täyttää liiketoiminta-, suunnittelu- ja toimintastandardit.
  3. Varmista, että dokumentaatio, tietoturvamallit, gateway-konfiguraatio ja lakisääteiset vaatimukset on määritelty selkeästi, validoitu ja tuettu todisteilla.

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.