Pojasnite nalogo in odločitev
Ta vodnik spremeni hitri zagon api v pregleden potek dela. Povezuje domenske odločitve, lastništvo, dokaze in sprejemanje, tako da rezultat še naprej deluje v proizvodnji.
Začnite z eno overjeno zahtevo, potrdite odgovorno pogodbo in dodajte obravnavo napak, preden povežete CMS.
Praktični postopek
- 1
Vrste virov inventarja, identifikatorji, polja, lokalne nastavitve, lastniki in stanja objave.
- 2
Izberite vzorec dostave med glasnostjo, zakasnitvijo, uredniškim nadzorom in toleranco napak.
- 3
Preslikaj izvorni zapis v ločen zapis jezikovne različice s trajno povezavo.
- 4
Dodajte preverjanje pristnosti, idempotenco, ponovni poskus, razveljavitev predpomnilnika, beleženje in nadzor dostopa.
- 5
Preskusna objava, spremembe vira, nerazpoložljivi rezultati, povrnitev nazaj, delovanje tipkovnice in spremljanje pred izdajo.
Primer ali orodje
Popoln par zahteve in odgovora vključuje avtentikacijo, področne nastavitve, način, idempotenco in obravnavanje napak. V orodju zabeležite tudi izhodišče, lastnika, odločitev, dokaze, odprto vprašanje in datum odobritve. Uporabite pravo stran ali transakcijo, da bo skupina videla odvisnosti, izjeme in vzdrževalna dela, ki sledijo izdaji.
| Točka odločitve | Zapis | Kriterij sprejemljivosti |
|---|---|---|
| Izhodišče | Opaženo trenutno stanje | Vir in datum zapisa |
| Odločitev | Izbrana možnost in utemeljitev | Upoštevano je tveganje in občinstvo |
| Dokazi | Preizkusite, dokumentirajte ali izmerite | Pregledljiv in specifičen za različico |
| Odobritev | Ime, vloga in datum | Izpolnjeni vsi obvezni kriteriji |
Pošljite eno povpraševanje v obliki proizvodnje
Ustvarite odjemalca za integracijo na strežniški strani in shranite njegovo poverilnico v tajnem upravitelju razmestitve. Pošljite UTF-8 JSON prek HTTPS s stabilnim izvornim identifikatorjem, izvorno revizijo, zahtevanim jezikom, jezikovnim načinom in telesom vsebine. Dodajte ključ za idempotenco, ki ostane enak, ko se ponovi isto opravilo. Ne izpostavljajte poverilnic v kodi brskalnika, datotekah repozitorija, poljih CMS, posnetkih zaslona ali odjemalcem vidnih odzivih na napake.
Začnite z reprezentativno, a neobčutljivo stranjo storitve. Vključite naslove, sezname, povezave in pravni ali operativni pogoj, tako da odgovor izvaja pravo vsebinsko pogodbo. Preden pokličete API, zavrnite prazen izvorni identifikator, nepodprte lokalne nastavitve, neznan način, preveliko telo ali napačno oblikovano strukturo. Nastavite eksplicitno časovno omejitev povezave in odziva ter razširite identifikator korelacije v dnevnike vaše aplikacije.
| Polje za zahtevo | Namen | Validacija |
|---|---|---|
| sourceId | Trajna povezava z zapisom CMS | Zahtevano, stabilno, neosebno |
| sourceRevision | Zazna zastarele rezultate | Zahtevano in nespremenljivo za zahtevo |
| kraj in način | Izbere jezikovna pravila | Mora biti omogočena kombinacija |
| idempotencyKey | Omogoča varne ponovne poskuse | Ista operacija uporablja isti ključ |
Potrdite celotno pogodbo o odgovoru
Uspešno stanje HTTP obravnavajte le kot prvo preverjanje. Preverite shemo odziva, identifikator rezultata, identifikator vira in revizijo, področne nastavitve, jezikovni način, status obdelave, bloke vsebine, opozorila in različico modela ali nabora pravil, kjer je na voljo. Neznane enum vrednosti in manjkajoča zahtevana polja se ne bi smela zapreti v pregledno integracijsko napako. Ohranite opozorila poleg osnutka, ker lahko prepoznajo terminologijo, kakovost vira ali zahteve glede ročnega pregleda.
Shranite ustvarjeni izhod kot ločen osnutek revizije, namesto da prepišete odobreni vir. Zabeležite identifikatorje zahtev in rezultatov, nastavitve transformacije, časovne žige in zgoščeno vrednost celovitosti izvorne revizije. Upodobi diff za pregledovalce in izogni vsem izhodom glede na cilj. Ustvarjena oznaka je nezaupljiv vnos, dokler ni dokončano preverjanje sheme, čiščenje, preverjanje dostopnosti in človeška odobritev.
- 1
Preverite veljavnost izhodnega koristnega tovora glede na lokalno shemo.
- 2
Pošljite zahtevo z glavami za preverjanje pristnosti, časovno omejitev, idempotenco in korelacijo.
- 3
Preverite status, glave in telo odgovora glede na pripeto pogodbo.
- 4
Ustvarite ločen osnutek CMS, povezan s točno izvorno revizijo.
- 5
Usmerite opozorila in razlike v pravilno čakalno vrsto za uredniški pregled.
Obravnavajte napake brez podvajanja ali izgube dela
Časovne omejitve ponovnega poskusa, napake povezave in omejitve hitrosti le, če je operacija idempotentna. Uporabite omejen eksponentni odmik s tresenjem in upoštevajte zakasnitev ponovnega poskusa, ki jo zagotovi strežnik. Neuspešnega preverjanja veljavnosti, napak pri preverjanju pristnosti ali nepodprtih možnosti ne poskušajte znova izvajati, dokler se konfiguracija ne spremeni. Postavite izčrpane operacije v čakalno vrsto mrtvih pisem z virom, kategorijo varne napake, številom poskusov in naslednjo odgovorno ekipo.
Ločite stanje uporabnika od diagnostičnih podrobnosti. Uredniki potrebujejo jasna stanja, kot so v čakalni vrsti, obdelava, pripravljen osnutek, zahtevano dejanje in neuspešno z varnim naslednjim korakom. Operacije potrebujejo identifikatorje zahtev, trajanje, statusno kategorijo in zgodovino ponovnih poskusov, ne pa celotnega izvornega besedila v navadnih dnevnikih. Opozorilo o trajni stopnji napak, naraščajoči starosti čakalne vrste, napakah pri preverjanju pristnosti, neujemanju shem in osnutkih, katerih izvorna revizija se je med obdelavo spremenila.
Vsaka ponovna operacija ima stabilen ključ idempotence.
Odstop je omejen in upošteva navodila za omejitev stopnje.
Dnevniki izključujejo poverilnice in telesa nepotrebne vsebine.
Predmeti mrtvega pisma imajo lastnika in postopek ponovnega predvajanja.
Zastarel rezultat ne more tiho nadomestiti novejše izvorne revizije.
Dokažite integracijo pred izdajo
Preizkusite veljavne zahteve, vsako dokumentirano napako pri preverjanju, potekle in preklicane poverilnice, časovne omejitve, omejitve hitrosti, podvojene oddaje, dokončanje izven vrstnega reda, razvoj sheme, čiščenje in spremembe vira med obdelavo. Prepričajte se, da spremljanje prepozna vsako napako in da lahko usposobljen operater ponovno predvaja ali zapre element brez urejanja baze podatkov. Zaženite dostopnost in uredniški pregled na upodobljenem osnutku in ne samo na surovem odgovoru.
Izdaja z omejeno poverilnico, določeno stopnjo in omejitvami porabe, nadzornimi ploščami, lastništvom opozoril in stikalom za povrnitev, ki ustavi novo generacijo brez vpliva na objavljeno vsebino. Pripnite podprto pogodbeno različico in načrtujte pregled nadgradnje. Zapis o prevzemu proizvodnje mora vključevati dokaze o preskusu, varnostno odobritev, dokumentacijo o pretoku podatkov, odjavo pregledovalca, navodila za uporabo in uspešno obnovitev enega namerno neuspešnega opravila.
Vloge, dokazi in odobritev
Generiranje naj bo ločeno od objave. Uspešen odgovor je osnutek, ne odobritev. Shranite izvorni identifikator in različico, nastavitve transformacije, identifikator rezultata, stanje pregleda, odobritelja in čas objave. Ko se vir spremeni, označite jezikovno različico za pregled, namesto da tiho zamenjate odobreno vsebino. To omogoča povrnitev in revizijo na vseh platformah.
Delovanje in vzdrževanje
Delo se ne konča z objavo. Povežite jezikovno različico ali konfiguracijo z njenim izvorom, spremljajte ukrepe kakovosti in storitev ter definirajte konkretne sprožilce pregleda. Sprožilci vključujejo spremembe vira, pravne spremembe, nove potrebe občinstva, ponavljajoča se vprašanja podpore, tehnične spremembe in incidente. Imenovani lastnik oceni sprožilec, po potrebi odpre novo revizijo in zabeleži ponovno odobritev.
Kontrolni seznam za objavo
Integracija uporablja trajne izvorne identifikatorje.
Poverilnice so shranjene na strani strežnika in se izmenjujejo.
Določeni so časovna omejitev, ponovni poskus in omejitev hitrosti.
Ponavljajoče se zahteve so idempotentne.
Ustvarjena vsebina preide v stanje pregleda.
Spremembe vira razveljavijo ali znova odprejo različico.
Jezikovna navigacija deluje s pomočjo tipkovnice in podporne tehnologije.
Spremljanje zajema napake, čakalne vrste, zakasnitev in zastarelo vsebino.