Station

Sopimussuunnittelu - Määrittele selkeät API-sopimukset

Luo selkeät ja hyvin määritellyt API-sopimukset, joissa hahmotellaan odotukset, vastuut ja käyttöohjeet.

API-rajapintasopimukset ovat olennaisen tärkeitä, jotta API-toimittajien ja hyödyntäjien välillä on selkeys ja yhdenmukaisuus. Tämä asema tarjoaa ohjeita selkeiden, kattavien ja helposti ymmärrettävien API-rajapintasopimusten suunnitteluun.

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 hallintaStrategia1KyvykkyysstrategiaHyödyntäjien vaatimukset ja käyttöönotto2Hyödyntäjien vaatimuksetja käyttöönottoArkkitehtuuri- ja alustapäätökset3Arkkitehtuuri jaalustaratkaisutRatkaisu- ja rajapintasuunnittelu4Ratkaisu- jarajapintasuunnitteluToimitus ja operointi5Toimitus ja operointiLaadun ja valmiuden varmistus6Laadun ja valmiudenvarmistusJulkaisu ja käyttöönoton mahdollistaminen7Julkaisu ja kayttoonotontukiSeuranta ja parantaminen8Seuranta ja parantaminenLiiketoimintamahdollisuuksien linjaAlusta-arkkitehtuurilinjaAPI-suunnittelulinjaToimituslinjaJulkaisu- ja käyttöönoton linjaToimintamallilinja

Selected station: Sopimussuunnittelu - Määrittele selkeät API-sopimukset

Tarvittavat sidosryhmät

Liittyvät resurssit

Tulokset

  • Kullekin ajapinnalle määritellyt selkeät API-sopimukset
  • API-toimittajien ja hyödyntäjien odotukset ja vastuut kuvattuina
  • Käyttöohjeet ja parhaat käytännöt dokumentoitu
  • APIn käyttöä koskevien väärinkäsitysten ja riitojen väheneminen.

Matkan kriteerit

Aloituskriteerit

Valmistumiskriteerit

Tältä onnistuminen näyttää

Tarjotaan sopimussuunnittelumalleja, standardoituja muotoja ja tarkistusprosesseja. Varmistetaan, että tiimit luovat selkeät ja hyvin määritellyt API-sopimukset, joissa hahmotellaan odotukset, vastuut ja käyttöohjeet.

  1. Määrittele API-sopimukset, joissa hahmotellaan kunkin APIn odotukset, vastuut ja käyttöohjeet.
  2. Käytä standardoituja formaatteja (esim. OpenAPI, AsyncAPI) luodaksesi koneellisesti luettavia API-sopimuksia, joita on helppo jakaa ja validoida.
  3. Varmistetaan, että sidosryhmät tarkistavat ja hyväksyvät API-sopimukset, jotta varmistetaan niiden yhdenmukaisuus ja selkeys. — API-auditoinnin tarkistuslista

Metro lines

Toimituslinja

Kattaa toteutuksen, testauksen, automaation ja toimituskäytännöt.

Liittyvät resurssit

Browse the resources selected for Sopimussuunnittelu - Määrittele selkeät API-sopimukset; the summary above explains how they support this station’s work.

Resurssit

Resources for Sopimussuunnittelu - Määrittele selkeät API-sopimukset

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