Išsiaiškinkite užduotį ir sprendimą
Šis vadovas api greitąją paleidimą paverčia peržiūrima darbo eiga. Jis sujungia domeno sprendimus, nuosavybės teisę, įrodymus ir priėmimą, kad rezultatas ir toliau veiktų gamyboje.
Pradėkite nuo vienos autentifikuotos užklausos, patvirtinkite atsakymo sutartį ir pridėkite trikčių apdorojimą prieš prijungdami CMS.
Praktinė eiga
- 1
Atsargų šaltinio tipai, identifikatoriai, laukai, lokalės, savininkai ir publikavimo būsenos.
- 2
Pasirinkite pristatymo modelį iš apimties, delsos, redakcinės kontrolės ir klaidų tolerancijos.
- 3
Susiekite šaltinio įrašą su atskiru kalbos versijos įrašu su patvariu ryšiu.
- 4
Pridėkite autentifikavimo, idempotencijos, pakartotinio bandymo, talpyklos negaliojimo, registravimo ir prieigos valdiklius.
- 5
Bandomasis leidinys, šaltinio pakeitimai, nepasiekiami rezultatai, atšaukimas, klaviatūros veikimas ir stebėjimas prieš išleidžiant.
Pavyzdys arba priemonė
Visa užklausų ir atsakymų pora apima autentifikavimą, lokalę, režimą, idempotenciją ir klaidų tvarkymą. Įrankyje taip pat įrašykite pradinę padėtį, savininką, sprendimą, įrodymus, atvirą problemą ir patvirtinimo datą. Naudokite tikrą puslapį arba operaciją, kad komanda matytų priklausomybes, išimtis ir priežiūros darbus po išleidimo.
| Sprendimo taškas | Įrašas | Priėmimo kriterijus |
|---|---|---|
| Bazinė linija | Stebėta dabartinė būklė | Įrašymo šaltinis ir data |
| Sprendimas | Pasirinktas variantas ir pagrindimas | Atsižvelgta į riziką ir auditoriją |
| Įrodymai | Išbandykite, dokumentuokite arba išmatuokite | Galima peržiūrėti ir atsižvelgiant į versiją |
| Patvirtinimas | Vardas, vaidmuo ir data | Atitiko visi privalomi kriterijai |
Siųsti vieną gamybos formos užklausą
Sukurkite serverio pusės integravimo klientą ir išsaugokite jo kredencialus diegimo slaptojoje tvarkyklėje. Siųskite UTF-8 JSON per HTTPS su stabiliu šaltinio identifikatoriumi, šaltinio versija, prašoma lokale, kalbos režimu ir turinio tekstu. Pridėkite idempotencijos raktą, kuris išlieka toks pat, kai bandoma atlikti identišką užduotį. Neatskleiskite kredencialų naršyklės kode, saugyklos failuose, CMS laukuose, ekrano kopijose ar kliento matomų klaidų atsakymuose.
Pradėkite nuo reprezentatyvaus, bet neskelbtino paslaugų puslapio. Įtraukite antraštes, sąrašus, nuorodas ir teisines arba veiklos sąlygas, kad atsakymas atitiktų tikrojo turinio sutartį. Prieš skambindami API, atmeskite tuščią šaltinio identifikatorių, nepalaikomą lokalę, nežinomą režimą, per didelį turinį arba netinkamai suformuotą struktūrą. Nustatykite aiškų ryšio ir atsako skirtąjį laiką ir perkelkite koreliacijos identifikatorių į programos žurnalus.
| Užklausos laukas | Tikslas | Patvirtinimas |
|---|---|---|
| šaltinio ID | Patvari nuoroda į CMS įrašą | Reikalingas, stabilus, neasmeniškas |
| šaltinisPeržiūra | Aptinka pasenusius rezultatus | Reikalingas ir nepakeičiamas užklausai |
| lokalę ir režimą | Parenka kalbos taisykles | Turi būti įjungtas derinys |
| idempotencyKey | Padaro pakartotinius bandymus saugius | Ta pati operacija naudoja tą patį klavišą |
Patvirtinkite visą atsakymo sutartį
Laikykite sėkmingą HTTP būseną tik pirmąja patikra. Patvirtinkite atsakymo schemą, rezultato identifikatorių, šaltinio identifikatorių ir peržiūrą, lokalę, kalbos režimą, apdorojimo būseną, turinio blokus, įspėjimus ir modelio arba taisyklių rinkinio versiją, jei ji pateikta. Nežinomos sąrašo reikšmės ir trūkstami privalomi laukai neturėtų būti uždaryti į peržiūrimos integravimo klaidą. Išsaugokite įspėjimus šalia juodraščio, nes juose galima nustatyti terminus, šaltinio kokybę arba neautomatinio peržiūros reikalavimus.
Išsaugokite sugeneruotą išvestį kaip atskirą versiją, o ne perrašydami patvirtintą šaltinį. Įrašykite užklausų ir rezultatų identifikatorius, transformacijos nustatymus, laiko žymes ir šaltinio versijos vientisumo maišą. Pateikite skirtumą apžvalgininkams ir išeikite iš visos išvesties pagal paskirties vietą. Sugeneruotas žymėjimas yra nepatikimas, kol nebus baigtas schemos patvirtinimas, dezinfekavimas, prieinamumo patikros ir žmogaus patvirtinimas.
- 1
Patvirtinkite siunčiamą naudingą apkrovą pagal vietinę schemą.
- 2
Išsiųskite užklausą su autentifikavimo, skirtojo laiko, idempotencijos ir koreliacijos antraštėmis.
- 3
Patvirtinkite būseną, antraštes ir atsakymo turinį pagal prisegtą sutartį.
- 4
Sukurkite atskirą CMS juodraštį, susietą su tikslia šaltinio versija.
- 5
Nukreipkite įspėjimus ir skirtumus į tinkamą redakcinės peržiūros eilę.
Tvarkykite klaidas nedubliuodami ir neprarasdami darbo
Pakartokite skirtąjį laiką, ryšio gedimus ir greičio apribojimus tik tada, kai operacija neveikia. Naudokite ribotą eksponentinį atsitraukimą su virpėjimu ir laikykitės serverio suteiktos pakartotinio bandymo delsos. Nebandykite pakartotinai patvirtinimo, autentifikavimo klaidų ar nepalaikomų parinkčių, kol nepasikeis konfigūracija. Įdėkite išnaudotas operacijas į negyvos raidės eilę su šaltinio nuoroda, saugios klaidos kategorija, bandymų skaičiumi ir kita atsakinga komanda.
Atskirkite naudotojui skirtą būseną nuo diagnostinės informacijos. Redaktoriams reikia aiškių būsenų, pvz., eilėje, apdorojimas, juodraštis paruoštas, reikalingas veiksmas ir nepavyko atlikti saugaus kito veiksmo. Veiksmams reikia užklausų identifikatorių, trukmės, būsenos kategorijos ir pakartotinių bandymų istorijos, bet ne viso šaltinio teksto įprastuose žurnaluose. Įspėjimas apie nuolatinį klaidų dažnį, augantį eilės amžių, autentifikavimo klaidas, schemų neatitikimus ir juodraščius, kurių šaltinio versija pasikeitė apdorojimo metu.
Kiekviena pakartotinai bandoma operacija turi stabilų idempotencijos raktą.
Atšaukimas yra apribotas ir laikomasi normos ribojimo nurodymų.
Į žurnalus neįtraukiami kredencialai ir nereikalingi turinio elementai.
Negyvos raidės daiktai turi savininką ir atkūrimo procedūrą.
Pasenęs rezultatas negali tyliai pakeisti naujesnės šaltinio versijos.
Prieš išleisdami įrodykite integraciją
Išbandykite galiojančias užklausas, kiekvieną dokumentais patvirtintą patvirtinimo klaidą, pasibaigusius ir atšauktus kredencialus, skirtąjį laiką, greičio apribojimus, pasikartojančius pateikimus, netvarkos užbaigimą, schemos evoliuciją, dezinfekavimą ir šaltinio pakeitimus apdorojimo metu. Patvirtinkite, kad stebėjimas identifikuoja kiekvieną gedimą ir kad apmokytas operatorius gali atkurti arba uždaryti elementą neredaguodamas duomenų bazės. Paleiskite pasiekiamumą ir redakcinę peržiūrą pateiktam juodraštiui, o ne tik neapdorotam atsakymui.
Išleisk su apribotais kredencialais, nustatytais tarifų ir išlaidų limitais, prietaisų skydeliais, įspėjimo nuosavybės teise ir atšaukimo jungikliu, kuris sustabdo naujos kartos, nepaveikdamas paskelbto turinio. Prisekite palaikomą sutarties versiją ir suplanuokite atnaujinimo peržiūrą. Gamybos priėmimo įrašas turėtų apimti bandymo įrodymus, saugos patvirtinimą, duomenų srauto dokumentus, recenzento pasirašymą, naudojimo instrukcijas ir sėkmingą vienos tyčia nepavykusios užduoties atkūrimą.
Vaidmenys, įrodymai ir patvirtinimas
Laikykite generavimą atskirai nuo publikavimo. Sėkmingas atsakymas yra juodraštis, o ne patvirtinimas. Išsaugokite šaltinio identifikatorių ir versiją, transformacijos nustatymus, rezultato identifikatorių, peržiūros būseną, tvirtintoją ir paskelbimo laiką. Pasikeitus šaltiniui, pažymėkite kalbos versiją, kad būtų galima peržiūrėti, o ne tyliai pakeiskite patvirtintą turinį. Tai leidžia atkurti ir atlikti auditą visose platformose.
Operacijos ir priežiūra
Darbas nesibaigia publikavimu. Susiekite kalbos versiją arba konfigūraciją su šaltiniu, stebėkite kokybės ir paslaugų priemones ir nustatykite konkrečius peržiūros veiksnius. Trigeriai apima šaltinio pakeitimus, teisinius pakeitimus, naujus auditorijos poreikius, pasikartojančius palaikymo klausimus, techninius pakeitimus ir incidentus. Įvardytas savininkas įvertina aktyviklį, prireikus atidaro naują versiją ir įrašo atnaujintą patvirtinimą.
Skelbimo kontrolinis sąrašas
Integruojant naudojami patvarūs šaltinio identifikatoriai.
Kredencialai saugomi serverio pusėje ir pasukami.
Apibrėžiamas skirtasis laikas, bandymas pakartotinai ir greičio ribojimo elgesys.
Pakartotiniai prašymai yra idempotenti.
Sugeneruotas turinys pereina į peržiūros būseną.
Šaltinio pakeitimai anuliuoja arba iš naujo atidaro versiją.
Kalbos navigacija veikia naudojant klaviatūrą ir pagalbines technologijas.
Stebėjimas apima gedimus, eiles, delsą ir pasenusį turinį.