CMS un API

Tīmekļa aizķeres un pakešu apstrāde.

Atlasiet sinhrono, tīmekļa aizķeres vai pakešu piegādi no apjoma, latentuma, atkārtota mēģinājuma un darbības īpašumtiesībām.

Noskaidrojiet uzdevumu un lēmumu

Šī rokasgrāmata pārvērš tīmekļa aizķeres un pakešu apstrādi pārskatāmā darbības darbplūsmā. Tas savieno domēna lēmumus, īpašumtiesības, pierādījumus un pieņemšanu, lai rezultāts turpinātu darboties ražošanā.

Atlasiet sinhrono, tīmekļa aizķeres vai pakešu piegādi no apjoma, latentuma, atkārtota mēģinājuma un darbības īpašumtiesībām.

Praktiskā darba gaita

  1. 1

    Krājumu avotu veidi, identifikatori, lauki, lokalizācijas, īpašnieki un publikācijas stāvokļi.

  2. 2

    Izvēlieties piegādes modeli no skaļuma, latentuma, redakcionālās kontroles un kļūdu pielaides.

  3. 3

    Kartējiet avota ierakstu ar atsevišķu valodas versijas ierakstu ar izturīgu saiti.

  4. 4

    Pievienojiet autentifikāciju, idempotenci, atkārtotu mēģinājumu, kešatmiņas nederīgumu, reģistrēšanu un piekļuves vadīklas.

  5. 5

    Testa publikācija, avota izmaiņas, nepieejami rezultāti, atcelšana, tastatūras darbība un uzraudzība pirms izlaišanas.

Piemērs vai rīks

Dzīves cikla diagramma kļūst par ieviešanas līgumu atkārtotiem mēģinājumiem, idempotencei, uzraudzībai un atkārtošanai. Rīkā ierakstiet arī sākotnējo stāvokli, īpašnieku, lēmumu, pierādījumus, atklāto jautājumu un apstiprināšanas datumu. Izmantojiet īstu lapu vai darījumu, lai komanda redzētu atkarības, izņēmumus un uzturēšanas darbus pēc izlaišanas.

Lēmuma punktsIerakstsPieņemšanas kritērijs
PamatlīnijaNovērots pašreizējais stāvoklisAvots un ierakstīšanas datums
LēmumsIzvēlētais variants un pamatojumsApsvērts risks un auditorija
PierādījumiPārbaudi, dokumentē vai mēraPārskatāms un konkrētai versijai
ApstiprināšanaVārds, loma un datumsVisi obligātie kritēriji ir izpildīti

Izvēlieties piegādi no latentuma, apjoma un īpašumtiesībām

Izmantojiet sinhrono piegādi maziem interaktīviem pieprasījumiem, kas parasti tiek pabeigti saskarnes noildzes laikā un var nekavējoties ziņot par rezultātu. Izmantojiet tīmekļa aizķeres, kad darbs ir asinhrons, taču katram rezultātam ir jāievada CMS, tiklīdz tas ir gatavs. Izmantojiet pakešu apstrādi lielām plānotām kolekcijām, kontrolētam importam vai migrācijai, kur caurlaidspēja un reproducējamība ir svarīgāka par tūlītēju piegādi. Modeļi var pastāvēt līdzās, taču katrai satura klasei ir jābūt dokumentētai noklusējuma vērtībai.

Aprēķiniet dienas un maksimālo apjomu, preces lielumu, pieņemamo pabeigšanas laiku, atkārtotā mēģinājuma periodu, pasūtīšanas prasību, pārskatītāju kapacitāti un darbības īpašnieku. Ātram rezultātam nav vērtības, ja redakcijas rinda nevar to apstrādāt. Iekļaujiet augšējos un pakārtotos ierobežojumus: CMS eksportēšana, API ātrums, rindas darbinieki, atzvanīšanas galapunkts, datu bāzes rakstīšana, kešatmiņas nederīgums un pārskatīšanas darba slodze. Izvēlieties vienkāršāko modeli, kas atbilst pilnīgam pakalpojuma mērķim.

RakstsIzmantojiet, kadBūtiska kontrole
SinhronsNeliels pieprasījums un īss latentumsTaimauts ar drošu klienta atkārtotu mēģinājumu
Web aizķereNeatkarīgi darbi jāierodas nekavējotiesParaksta pārbaude un idempotenta notikumu apstrāde
PartijaLiels kontrolēts komplekts un plānotā pabeigšanaManifests, kontrolpunkts, samierināšana un atkārtošana

Ieviesiet pārbaudāmu tīmekļa aizķeres dzīves ciklu

Pieņemiet tikai HTTPS POST, pārbaudiet parakstu pret neapstrādātu pamattekstu, pārbaudiet laikspiedola toleranci un noraidiet neatbalstītās notikumu versijas. Pirms uzņēmējdarbības izmaiņu piemērošanas saglabājiet notikuma ID saskaņā ar unikālu ierobežojumu. Atgrieziet panākumus pēc ilgstošas ​​saņemšanas, pēc tam apstrādājiet asinhroni. Atkārtots notikums atgriež panākumus, neatkārtojot blakus efektu. Pagrieziet parakstīšanas noslēpumus ar pārklāšanās periodu un ierobežojiet diagnostikas izvadi, lai tas neatklātu parakstus vai saturu.

Modeļa stāvokļi, piemēram, saņemts, apstiprināts, saskaņots, lietots, ignorēts, atkārtots mēģinājums un neizdevās. Saskaņojiet rezultātu ar darba ID, avota ID, avota pārskatīšanu, lokalizāciju un režīmu. Ja pašreizējais avots ir jaunāks, saglabājiet rezultātu auditam, bet neatveriet un neaizstājiet pašreizējo melnrakstu. Apstrādājiet ārpus kārtas notikumus, izmantojot stāvokļa pārejas noteikumus, nevis ierašanās secību. Saglabājiet atkārtošanas rīku, kam nepieciešams iemesls, operatora identitāte un darbības joma.

  1. 1

    Pārbaudiet transportēšanu, neapstrādāta teksta parakstu, laikspiedolu, notikuma veidu un līguma versiju.

  2. 2

    Nepārtrauciet unikālo notikumu un apstipriniet izturīgu saņemšanu.

  3. 3

    Pirms CMS maiņas atrisiniet darbu un precīzu avota pārskatīšanu.

  4. 4

    Lietojiet idempotenta stāvokļa pāreju un izveidojiet pārskatāmu melnrakstu.

  5. 5

    Ierakstiet pabeigšanu vai virziet notikumu, lai kontrolētu atkārtotu mēģinājumu un atskaņošanu.

Padariet partijas reproducējamas un saskaņojamas

Izveidojiet nemainīgu manifestu ar partijas ID, izveides laiku, vaicājumu vai atlases kārtulu, atsevišķa vienuma ID, avota pārskatīšanu, lokalizāciju, režīmu, prioritāti un kontrolsummu. Pirms iesniegšanas iesaldējiet manifestu, lai vēlāk CMS vaicājums nevarētu mainīt partijas nozīmi. Sadaliet to ierobežotos gabalos un katram vienumam izmantojiet stabilas idempotences atslēgas. Kontrolpunkta pabeigšana pēc ilgstošas ​​rakstīšanas, lai darbinieki varētu atsākt darbu, nesākot no jauna.

Beigās saskaņojiet iesniegtos, pieņemtos, pabeigtos, noraidītos, novecojušos, neizdevušos un apzināti izlaistos vienumus. Skaitļiem ir jābūt līdzsvarotiem ar sākotnējo manifestu, un katram nepabeigtam vienumam ir nepieciešams iemesls un nākamā darbība. Atkārtoti atskaņojot apakškopu, tiek izveidots jauns atkārtošanas manifests, kas ir saistīts ar oriģinālu. Nemainiet sākotnējos skaitļus un neizdzēsiet pierādījumus, kas nav bijuši. Publicējiet pakešu rezultātus tikai pārskatīšanas stāvokļos ar darba slodzes ierobežojumiem, kas aizsargā redakcijas komandu.

  • Manifestā tiek labota vienuma identitāte, avota pārskatīšana, iestatījumi un kontrolsumma.

  • Katra vienumu darbība ir idempotena un neatkarīgi atkārtoti izmēģināma.

  • Pārbaudes punkti tiek atsākti pēc pārtraukuma, nedublējot melnrakstus.

  • Galīgā statusa uzskaite precīzi sakrīt ar manifestu.

  • Atkārtošana ir tvēruma, autorizēta, saistīta un pārbaudāma.

Pārraugiet rindas un atkārtojiet atkopšanu

Pārraugiet pieņemto biežumu, pabeigšanas līmeni, kļūdu biežumu pēc kategorijas, rindas dziļumu, vecākā vienuma vecumu, apstrādes ilguma procentiles, tīmekļa aizķeres pārbaudes kļūmes, atkārtoto mēģinājumu skaitu, mirušo burtu apjomu, novecojušo rezultātu biežumu un laiku no rezultāta līdz redakcijas apstiprināšanai. Brīdinājums par lietotāju ietekmi un pieaugošo kavējumu skaitu, nevis atsevišķām pārejošām kļūmēm. Informācijas paneļi atdala pakalpojumu sniedzēja apstrādi, atzvanīšanas piegādi, lietojumprogrammu CMS un redakcijas gaidīšanas laiku.

Runbook identificē īpašniekus, drošo pauzi, mērogošanas ierobežojumus, akreditācijas datu rotāciju, atkārtošanas apstiprināšanu, beztermiņa burtu apstrādi, pakalpojumu sniedzēja saziņu un atkopšanas verifikāciju. Vingrinājuma pazaudēta atzvanīšana, atkārtots notikums, ārpuskārtas notikums, pakalpojumu sniedzēja darbības pārtraukums, CMS darbības pārtraukums, shēmas neatbilstība, beidzies noslēpums un daļēja pakešu pabeigšana. Lai to pieņemtu, ir nepieciešama atkopšana bez dublikāta publicēšanas, klusuma zuduma, manuālas datu bāzes rediģēšanas vai pēdējā apstiprinātā satura noņemšanas.

Lomas, pierādījumi un apstiprinājums

Saglabājiet ģenerēšanu atsevišķi no publikācijas. Veiksmīga atbilde ir melnraksts, nevis apstiprinājums. Saglabājiet avota identifikatoru un versiju, transformācijas iestatījumus, rezultāta identifikatoru, pārskatīšanas stāvokli, apstiprinātāju un publicēšanas laiku. Kad avots mainās, atzīmējiet valodas versiju pārskatīšanai, nevis klusi nomainiet apstiprināto saturu. Tas padara iespējamu atcelšanu un auditu visās platformās.

Darbības un apkope

Darbs nebeidzas ar publicēšanu. Saistiet valodas versiju vai konfigurāciju ar tās avotu, uzraugiet kvalitātes un pakalpojumu pasākumus un definējiet konkrētus pārskatīšanas aktivizētājus. Aktivizētāji ietver avota izmaiņas, juridiskās izmaiņas, jaunas auditorijas vajadzības, periodiskus atbalsta jautājumus, tehniskas izmaiņas un incidentus. Nosaukts īpašnieks novērtē aktivizētāju, vajadzības gadījumā atver jaunu versiju un reģistrē atjaunoto apstiprinājumu.

Publicēšanas kontrolsaraksts

  • Integrācija izmanto noturīgus avota identifikatorus.

  • Akreditācijas dati tiek saglabāti servera pusē un pagriezti.

  • Noildze, atkārtots mēģinājums un ātruma ierobežojuma darbība ir definēta.

  • Atkārtoti pieprasījumi ir idempotenti.

  • Ģenerētais saturs nonāk pārskatīšanas stāvoklī.

  • Avota izmaiņas padara versiju nederīgu vai atkārtoti atver versiju.

  • Valodu navigācija darbojas, izmantojot tastatūru un palīgtehnoloģijas.

  • Uzraudzība attiecas uz kļūmēm, rindām, latentumu un novecojušu saturu.

Autoritatīvi avoti

  1. Simple8 API dokumentācija
  2. Simple8 piegādes modeļi
  3. Tīmekļa satura pieejamības vadlīnijas (WCAG) 2.2

Izmantojiet rokasgrāmatu praksē

Pārbaudiet Simple8 ar reprezentatīvu saturu un izmantojiet kontrolsarakstu, lai plānotu kontrolētu ražošanas darbplūsmu.

Pārbaudi savu tekstu