Iċċara l-kompitu u d-deċiżjoni
Din il-gwida tibdel il-quickstart tal-api fi fluss tax-xogħol operattiv li jista' jiġi rivedut. Tgħaqqad id-deċiżjonijiet tad-dominju, is-sjieda, l-evidenza u l-aċċettazzjoni sabiex ir-riżultat ikompli jaħdem fil-produzzjoni.
Ibda b'talba waħda awtentikata, ivvalida l-kuntratt ta 'rispons, u żid l-immaniġġjar tal-falliment qabel ma tikkonnettja l-CMS.
Proċess prattiku
- 1
Tipi ta 'sors ta' inventarju, identifikaturi, oqsma, lokalitajiet, sidien, u stati ta 'pubblikazzjoni.
- 2
Agħżel il-mudell tal-kunsinna minn volum, latency, kontroll editorjali, u tolleranza ta 'falliment.
- 3
Immappja r-rekord tas-sors għal rekord separat tal-verżjoni tal-lingwa b'rabta durabbli.
- 4
Żid awtentikazzjoni, idempotenza, ipprova mill-ġdid, invalidazzjoni tal-cache, illoggjar, u kontrolli tal-aċċess.
- 5
Pubblikazzjoni tat-test, bidliet fis-sors, riżultati mhux disponibbli, rollback, tħaddim tat-tastiera, u monitoraġġ qabel ir-rilaxx.
Eżempju jew għodda
Par komplut ta' rikjesta u rispons jinkludi awtentikazzjoni, lokalizzazzjoni, mod, idempotenza, u mmaniġġjar ta' żbalji. Fl-għodda, irreġistra wkoll il-linja bażi, is-sid, id-deċiżjoni, l-evidenza, il-ħruġ miftuħ u d-data tal-approvazzjoni. Uża paġna jew transazzjoni reali sabiex it-tim jara dipendenzi, eċċezzjonijiet, u x-xogħol ta 'manutenzjoni li jsegwi r-rilaxx.
| Punt tad-deċiżjoni | Rekord | Kriterju ta' aċċettazzjoni |
|---|---|---|
| Linja bażi | Stat attwali osservat | Sors u data rreġistrati |
| Deċiżjoni | Għażla magħżula u raġuni | Riskju u udjenza kkunsidrati |
| Evidenza | Test, dokument, jew kejl | Rivedibbli u speċifiku għall-verżjoni |
| Approvazzjoni | Isem, rwol, u data | Il-kriterji obbligatorji kollha sodisfatti |
Ibgħat talba waħda f'forma ta 'produzzjoni
Oħloq klijent ta 'integrazzjoni fuq in-naħa tas-server u aħżen il-kredenzjali tiegħu fil-maniġer sigriet tal-iskjerament. Ibgħat UTF-8 JSON fuq HTTPS b'identifikatur tas-sors stabbli, reviżjoni tas-sors, lokalizzazzjoni mitluba, mod tal-lingwa, u korp tal-kontenut. Żid ċavetta ta 'idempotenza li tibqa' l-istess meta l-impjieg identiku jerġa 'jiġi ppruvat. Tesponix kredenzjali fil-kodiċi tal-browser, fajls repożitorji, oqsma CMS, screenshots, jew tweġibiet ta 'żbalji viżibbli mill-klijent.
Ibda b'paġna ta' servizz rappreżentattiva iżda mhux sensittiva. Inkludi intestaturi, listi, links, u kundizzjoni legali jew operattiva sabiex ir-rispons jeżerċita l-kuntratt tal-kontenut reali. Irrifjuta identifikatur tas-sors vojt, lokalità mhux appoġġjata, mod mhux magħruf, korp ta' daqs kbir, jew struttura ħażina qabel iċempel liż-API. Issettja konnessjoni espliċita u timeout tar-rispons u propaga identifikatur ta' korrelazzjoni fir-reġistri tal-applikazzjoni tiegħek.
| Il-qasam tat-talba | Għan | Validazzjoni |
|---|---|---|
| sourceId | Rabta dejjiema għar-rekord CMS | Meħtieġa, stabbli, mhux personali |
| sourceRevision | Jiskopri riżultati skaduti | Meħtieġa u immutabbli għat-talba |
| lokalità u mod | Jagħżel regoli tal-lingwa | Trid tkun taħlita attivata |
| idempotencyKey | Jagħmel tentattivi mill-ġdid sikuri | L-istess operazzjoni tuża l-istess ċavetta |
Ivvalida l-kuntratt tar-rispons sħiħ
Ittratta status HTTP ta 'suċċess bħala l-ewwel kontroll biss. Ivvalida l-iskema tar-rispons, l-identifikatur tar-riżultat, l-identifikatur tas-sors u r-reviżjoni, il-lokal, il-mod tal-lingwa, l-istatus tal-ipproċessar, il-blokok tal-kontenut, it-twissijiet, u l-verżjoni tal-mudell jew tas-sett ta’ regoli fejn ipprovdut. Valuri tal-enum mhux magħrufa u oqsma meħtieġa neqsin għandhom ma jingħalqu fi żball ta' integrazzjoni li jista' jiġi rivedut. Ippreserva t-twissijiet ħdejn l-abbozz għax jistgħu jidentifikaw ir-rekwiżiti tat-terminoloġija, il-kwalità tas-sors jew ir-reviżjoni manwali.
Aħżen l-output iġġenerat bħala abbozz ta' reviżjoni separat aktar milli tikteb fuq is-sors approvat. Rekord talba u identifikaturi tar-riżultat, settings tat-trasformazzjoni, timestamps, u hash tal-integrità tar-reviżjoni tas-sors. Agħti diff għar-reviżuri u taħrab l-output kollu skont id-destinazzjoni tiegħu. Il-markup iġġenerat huwa input mhux ta' fiduċja sakemm il-validazzjoni tal-iskema, is-sanitizzazzjoni, il-kontrolli tal-aċċessibbiltà, u l-approvazzjoni tal-bniedem ikunu kompluti.
- 1
Ivvalida t-tagħbija 'l barra kontra skema lokali.
- 2
Ibgħat it-talba b'headers ta' awtentikazzjoni, timeout, idempotenza u korrelazzjoni.
- 3
Ivvalida l-istatus, l-intestaturi, u l-korp tar-rispons kontra l-kuntratt ippinjat.
- 4
Oħloq abbozz CMS separat marbut mar-reviżjoni eżatta tas-sors.
- 5
It-twissijiet tar-rotta u d-differenzi fil-kju ta’ reviżjoni editorjali korretta.
Immaniġġja l-iżbalji mingħajr ma tidduplika jew titlef ix-xogħol
Ipprova mill-ġdid timeouts, fallimenti fil-konnessjoni, u limiti tar-rata biss meta l-operazzjoni tkun idempotenti. Uża backoff esponenzjali b'limitu b'jitter u rrispetta dewmien mill-ġdid ipprovdut mis-server. Tippruvax mill-ġdid fallimenti ta' validazzjoni, fallimenti ta' awtentikazzjoni, jew għażliet mhux appoġġjati sakemm tinbidel il-konfigurazzjoni. Poġġi l-operazzjonijiet eżawriti fi kju ta 'ittri mejta bir-referenza tas-sors, kategorija ta' żball sigur, għadd ta 'tentattivi, u t-tim responsabbli li jmiss.
Separa l-istat li jiffaċċja l-utent mid-dettall dijanjostiku. L-edituri jeħtieġu stati ċari bħal fil-kju, proċessar, abbozz lest, azzjoni meħtieġa, u fallew bi pass li jmiss sikur. L-operazzjonijiet jeħtieġu identifikaturi tat-talba, tul, kategorija tal-istatus, u storja ta' ppruvati mill-ġdid, iżda mhux it-test sors sħiħ f'logs ordinarji. Twissija dwar ir-rata ta' żball sostnuta, l-età tal-kju dejjem tikber, fallimenti ta' awtentikazzjoni, nuqqas ta' tlaqqigħ ta' skema, u abbozzi li r-reviżjoni tas-sors tagħhom inbidlet waqt l-ipproċessar.
Kull operazzjoni li tista 'tiġi ppruvata mill-ġdid għandha ċavetta ta' idempotenza stabbli.
Backoff huwa limitat u tonora l-istruzzjonijiet tal-limitu tar-rata.
Ir-reġistri jeskludu kredenzjali u korpi ta' kontenut mhux meħtieġ.
Oġġetti b'ittri mejta għandhom proċedura ta' sid u replay.
Riżultat skadut ma jistax jissostitwixxi reviżjoni tas-sors aktar ġdida fis-skiet.
Ipprova l-integrazzjoni qabel ir-rilaxx
Ittestja t-talbiet validi, kull żball ta' validazzjoni dokumentat, kredenzjali skaduti u revokati, timeouts, limiti tar-rata, sottomissjoni duplikata, tlestija barra mill-ordni, evoluzzjoni tal-iskema, sanitizzazzjoni, u bidliet fis-sors waqt l-ipproċessar. Ikkonferma li l-monitoraġġ jidentifika kull falliment u li operatur imħarreġ jista' jerġa' jilgħab jew jagħlaq l-oġġett mingħajr editjar tad-database. Mexxi l-aċċessibbiltà u r-reviżjoni editorjali fuq l-abbozz ipprovdut aktar milli biss ir-rispons mhux maħdum.
Rilaxx bi kredenzjali ristretta, limiti ta’ rata u infiq definiti, dashboards, sjieda ta’ twissija, u swiċċ ta’ rollback li jwaqqaf ġenerazzjoni ġdida mingħajr ma jaffettwa l-kontenut ippubblikat. Pin il-verżjoni tal-kuntratt appoġġjata u skeda reviżjoni tal-aġġornament. Ir-rekord tal-aċċettazzjoni tal-produzzjoni għandu jinkludi evidenza tat-test, approvazzjoni tas-sigurtà, dokumentazzjoni tal-fluss tad-dejta, iffirmar tar-reviżur, struzzjonijiet operattivi, u r-restawr b'suċċess ta 'xogħol wieħed li falla deliberatament.
Rwoli, evidenza, u approvazzjoni
Żomm il-ġenerazzjoni separata mill-pubblikazzjoni. Reazzjoni b'suċċess hija abbozz, mhux approvazzjoni. Aħżen l-identifikatur tas-sors u l-verżjoni, is-settings tat-trasformazzjoni, l-identifikatur tar-riżultat, l-istat tar-reviżjoni, l-approvazzjoni, u l-ħin tal-pubblikazzjoni. Meta s-sors jinbidel, immarka l-verżjoni tal-lingwa għal reviżjoni minflok ma tissostitwixxi bil-kwiet il-kontenut approvat. Dan jagħmel ir-rollback u l-awditjar possibbli fuq il-pjattaformi kollha.
Operazzjonijiet u manutenzjoni
Ix-xogħol ma jispiċċax mal-pubblikazzjoni. Qabbad il-verżjoni tal-lingwa jew il-konfigurazzjoni mas-sors tagħha, timmonitorja l-kwalità u l-miżuri tas-servizz, u ddefinixxi l-kawżi konkreti tar-reviżjoni. It-tqanqil jinkludu bidliet fis-sors, bidliet legali, ħtiġijiet ġodda ta 'udjenza, mistoqsijiet ta' appoġġ rikorrenti, bidliet tekniċi, u inċidenti. Sid imsemmi jevalwa l-grillu, jiftaħ reviżjoni ġdida meta jkun meħtieġ, u jirreġistra approvazzjoni mġedda.
Lista ta' kontroll għall-pubblikazzjoni
L-integrazzjoni tuża identifikaturi tas-sors durabbli.
Il-kredenzjali huma maħżuna fuq in-naħa tas-server u mdawra.
Il-timeout, il-prova mill-ġdid, u l-imġieba tal-limitu tar-rata huma definiti.
Talbiet ripetuti huma idempotenti.
Il-kontenut iġġenerat jidħol fi stat ta' reviżjoni.
Il-bidliet fis-sors jinvalidaw jew jerġgħu jiftħu l-verżjoni.
In-navigazzjoni lingwistika taħdem bit-tastiera u t-teknoloġija assistiva.
Il-monitoraġġ ikopri fallimenti, kjuwijiet, latency, u kontenut mhux użat.