Noskaidrojiet uzdevumu un lēmumu
Šī rokasgrāmata pārvērš API ātro palaišanu 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ā.
Sāciet ar vienu autentificētu pieprasījumu, apstipriniet atbildes līgumu un pievienojiet kļūdu apstrādi pirms CMS pievienošanas.
Praktiskā darba gaita
- 1
Krājumu avotu veidi, identifikatori, lauki, lokalizācijas, īpašnieki un publikācijas stāvokļi.
- 2
Izvēlieties piegādes modeli no skaļuma, latentuma, redakcionālās kontroles un kļūdu pielaides.
- 3
Kartējiet avota ierakstu ar atsevišķu valodas versijas ierakstu ar izturīgu saiti.
- 4
Pievienojiet autentifikāciju, idempotenci, atkārtotu mēģinājumu, kešatmiņas nederīgumu, reģistrēšanu un piekļuves vadīklas.
- 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
Pilns pieprasījumu un atbilžu pāris ietver autentifikāciju, lokalizāciju, režīmu, idempotenci un kļūdu apstrādi. 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 punkts | Ieraksts | Pieņemšanas kritērijs |
|---|---|---|
| Pamatlīnija | Novērots pašreizējais stāvoklis | Avots un ierakstīšanas datums |
| Lēmums | Izvēlētais variants un pamatojums | Apsvērts risks un auditorija |
| Pierādījumi | Pārbaudi, dokumentē vai mēra | Pārskatāms un konkrētai versijai |
| Apstiprināšana | Vārds, loma un datums | Visi obligātie kritēriji ir izpildīti |
Nosūtiet vienu produkcijas formas pieprasījumu
Izveidojiet servera puses integrācijas klientu un saglabājiet tā akreditācijas datus izvietošanas slepenajā pārvaldniekā. Nosūtiet UTF-8 JSON, izmantojot HTTPS, ar stabilu avota identifikatoru, avota versiju, pieprasīto lokalizāciju, valodas režīmu un satura pamattekstu. Pievienojiet idempotences atslēgu, kas paliek nemainīga, mēģinot atkārtoti veikt identisku darbu. Neatklājiet akreditācijas datus pārlūkprogrammas kodā, repozitorija failos, CMS laukos, ekrānuzņēmumos vai klienta redzamās kļūdu atbildēs.
Sāciet ar reprezentatīvu, bet nesensitīvu pakalpojuma lapu. Iekļaujiet virsrakstus, sarakstus, saites un juridiskus vai darbības nosacījumus, lai atbilde atbilstu patiesā satura līgumam. Pirms API izsaukšanas noraidiet tukšu avota identifikatoru, neatbalstītu lokalizāciju, nezināmu režīmu, pārāk lielu korpusu vai nepareizi veidotu struktūru. Iestatiet tiešu savienojuma un atbildes taimautu un izplatiet korelācijas identifikatoru savos lietojumprogrammu žurnālos.
| Pieprasījuma lauks | Mērķis | Validācija |
|---|---|---|
| avota ID | Izturīga saite uz CMS ierakstu | Nepieciešams, stabils, nepersonisks |
| avotsRevision | Atklāj novecojušus rezultātus | Pieprasījumam nepieciešams un nemainīgs |
| lokalizācija un režīms | Atlasa valodas noteikumus | Jābūt iespējotai kombinācijai |
| idempotencyKey | Padara atkārtotus mēģinājumus drošus | Tā pati darbība izmanto to pašu taustiņu |
Apstipriniet pilnu atbildes līgumu
Uztveriet veiksmīgu HTTP statusu tikai kā pirmo pārbaudi. Apstipriniet atbildes shēmu, rezultāta identifikatoru, avota identifikatoru un versiju, lokalizāciju, valodas režīmu, apstrādes statusu, satura blokus, brīdinājumus un modeļa vai kārtulu kopas versiju, ja tāda ir. Nezināmām uzskaites vērtībām un trūkstošajiem obligātajiem laukiem vajadzētu neizdoties slēgt pārskatāmā integrācijas kļūdā. Saglabājiet brīdinājumus blakus uzmetumam, jo tie var identificēt terminoloģiju, avota kvalitāti vai manuālas pārskatīšanas prasības.
Saglabājiet ģenerēto izvadi kā atsevišķu pārskatīšanas melnrakstu, nevis pārrakstot apstiprināto avotu. Ierakstiet pieprasījumu un rezultātu identifikatorus, transformācijas iestatījumus, laikspiedolus un avota versijas integritātes jaucējkodu. Atveidojiet diferenciāciju recenzentiem un izvairieties no visiem rezultātiem atbilstoši galamērķim. Ģenerētais marķējums ir neuzticama ievade, kamēr nav pabeigta shēmas validācija, dezinfekcija, pieejamības pārbaudes un cilvēka apstiprināšana.
- 1
Apstipriniet izejošo lietderīgo slodzi saskaņā ar vietējo shēmu.
- 2
Nosūtiet pieprasījumu ar autentifikācijas, taimauta, idempotences un korelācijas galvenēm.
- 3
Apstipriniet statusu, galvenes un atbildes pamattekstu pret piesprausto līgumu.
- 4
Izveidojiet atsevišķu CMS melnrakstu, kas ir saistīts ar precīzu avota versiju.
- 5
Maršrutējiet brīdinājumus un novirzes pareizajā redakcijas pārskatīšanas rindā.
Apstrādājiet kļūdas, nedublējot vai nezaudējot darbu
Atkārtoti mēģiniet taimautus, savienojuma kļūmes un ātruma ierobežojumus tikai tad, ja darbība ir idempotena. Izmantojiet ierobežotu eksponenciālu atkāpšanos ar nervozitāti un ievērojiet servera nodrošināto atkārtotā mēģinājuma aizkavi. Nemēģiniet atkārtoti validācijas kļūmes, autentifikācijas kļūmes vai neatbalstītas opcijas, kamēr nav mainīta konfigurācija. Ievietojiet izsmeltās darbības mirušo burtu rindā, norādot avota atsauci, drošās kļūdas kategoriju, mēģinājumu skaitu un nākamo atbildīgo komandu.
Atdaliet lietotāja stāvokli no diagnostikas datiem. Redaktoriem ir nepieciešami skaidri stāvokļi, piemēram, rindā, apstrāde, melnraksts gatavs, nepieciešama darbība un neizdevās ar drošu nākamo darbību. Darbībām ir nepieciešami pieprasījuma identifikatori, ilgums, statusa kategorija un atkārtoto mēģinājumu vēsture, bet ne pilns avota teksts parastajos žurnālos. Brīdinājums par ilgstošu kļūdu biežumu, augošu rindu vecumu, autentifikācijas kļūmēm, shēmu neatbilstībām un melnrakstiem, kuru avota pārskatīšana apstrādes laikā ir mainījusies.
Katrai atkārtoti izmēģināmai darbībai ir stabila idempotences atslēga.
Atkāpšanās ir ierobežota un ievēro likmes ierobežojumu norādījumus.
Žurnāli neietver akreditācijas datus un nevajadzīgus satura korpusus.
Dead-burtu sūtījumiem ir īpašnieks un atkārtošanas procedūra.
Novecojis rezultāts nevar klusi aizstāt jaunāku avota versiju.
Pirms izlaišanas pierādiet integrāciju
Apstrādes laikā pārbaudiet derīgus pieprasījumus, katru dokumentēto validācijas kļūdu, derīguma termiņu un atsauktos akreditācijas datus, taimautus, ātruma ierobežojumus, dublikātus, nepareizu izpildi, shēmas evolūciju, dezinfekciju un avota izmaiņas. Apstipriniet, ka pārraudzība identificē katru kļūdu un ka apmācīts operators var atkārtoti atskaņot vai aizvērt vienumu bez datu bāzes rediģēšanas. Veiciet pieejamību un redakcionālo pārskatīšanu renderētajam melnrakstam, nevis tikai neapstrādātajai atbildei.
Izlaidiet ar ierobežotiem akreditācijas datiem, noteiktiem likmju un tēriņu ierobežojumiem, informācijas paneļiem, brīdinājuma īpašumtiesībām un atcelšanas slēdzi, kas aptur jauno paaudzi, neietekmējot publicēto saturu. Piespraudiet atbalstīto līguma versiju un ieplānojiet jaunināšanas pārskatīšanu. Ražošanas pieņemšanas ierakstā jāiekļauj pārbaudes pierādījumi, drošības apstiprinājums, datu plūsmas dokumentācija, recenzenta parakstīšanās, lietošanas instrukcijas un viena apzināti neveiksmīga darba veiksmīga atjaunošana.
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.