Aloita tärkeimmästä

APIOps Cycles on Lean- ja palvelusuunnittelusta inspiroitu menetelmä API-rajapintojen suunnitteluun, parantamiseen ja skaalaamiseen. APIOps Cycles on vapaasti käytettävissä, muokattavissa ja jaettavissa Creative Commons Attribution–ShareAlike 4.0 -lisenssin nojalla. APIOps Cycles on kehitetty vuodesta 2017 lähtien, ja se on kasvanut yhteisön panoksella ja eri toimialojen käytännön projekteissa.

Kehittäjät ja muut, jotka haluavat osallistua menetelmän kehittämiseen, käyttää menetelmää paikallisesti tai osana tuotteitaan ja palveluitaan, voivat käyttää koko menetelmää, joka koostuu muutamasta lokalisoidusta JSON- ja markdown-tiedostosta, joita käytetään tällä sivustolla ja APIOps Cycles -avoimessa työkalussa, joka on saatavana myös npm-paketina. Tutustu myös kumppani- ja yhteisösivulle, josta saat apua menetelmän käyttöön sekä muihin API-tuotestrategiaa ja parhaita käytäntöjä koskeviin tarpeisiin.

APIOps Cycles -menetelmä perustuu metroverkostoon, jossa asemat ja linjat edustavat API-elinkaaren kriittisiä osa-alueita.

Kuinka se toimii (lyhyesti)

Ajattele APIOps Cycles -menetelmää kuin metroverkostoa:

• Ydinasemat = Tiettyyn API-ominaisuuteen keskittyvät toiminnot (esim. strategia, suunnittelu, auditointi, toimitus).
• esikaupunkien asemat = tukialueet (esim. turvallisuus, vaatimustenmukaisuus, lokalisointi).
• metrolinjat = teemalliset työnkulut, jotka ohjaavat tiimiäsi lähtöpisteestä tavoiteltavaan ominaisuuteen (esim. liiketoimintamahdollisuudet, toimintamalli, alustan arkkitehtuuri).
• Esikaupunkialueet = Näkökulmat, joissa useat ydinasemat, esikaupunkialueet ja metrolinjat kohtaavat (esim. strategiset, hallinnolliset, tekniset ja kuluttajien näkökulmat).
• Resurssit = Kankaat, ohjeet ja tarkistuslistat, jotka on linkitetty ydin- ja esikaupunkipysäkeistä ja auttavat tiimiäsi yhteistyössä ja kunkin ydinpysäkin sisään- ja uloskäyntikriteerien täyttämisessä, kun etenet linjoja pitkin. Voit liittyä järjestelmään mistä tahansa – tavoitteistasi riippuen – ja palata takaisin, vahvistaa tai toistaa.

Aloittaminen kolmessa vaiheessa

1. Tunnista nykyiset API-haasteesi

• Sinun ei tarvitse käydä kaikissa asemissa järjestyksessä. Aloita sen sijaan siitä, missä tiimisi tai organisaatiosi nykyiset tarpeet tai ongelmakohdat ovat, selaamalla metrolinjoja, ja valitsemalla kunkin aseman pääsykriteerit.

2. Valitse nopea reitti tarpeesi mukaan

• Uusi rakenne? Suuri uudistus? Hallinto ja skaalaus?

3. Tarvitsetko yhteistyötä tiimisi kanssa?

• Tarkista ohjeet ja linkit kankaisiin ja muihin resursseihin kunkin aseman sivulla. Lataa resurssisivuilta tai avaa CanvasCreator, avoimen lähdekoodin demotyökalu, jonka avulla voit täyttää tai viedä paikallisia kankaita JSON-, SVG- tai PNG-tiedostoina ja jakaa ne tiimisi kanssa. Saatavana myös npm-paketina.