Tisztázza a feladatot és a döntést
Ez az útmutató az api gyorsindítást áttekinthető működési munkafolyamattá változtatja. Összeköti a tartományi döntéseket, a tulajdonjogot, a bizonyítékokat és az elfogadást, így az eredmény továbbra is működik a termelésben.
Kezdje egy hitelesített kéréssel, érvényesítse a válaszszerződést, és adjon hozzá hibakezelést a CMS csatlakoztatása előtt.
Gyakorlati munkafolyamat
- 1
A készletforrás típusai, azonosítói, mezői, területei, tulajdonosai és közzétételi állapotai.
- 2
Válassza ki a kézbesítési mintát a mennyiség, a várakozási idő, a szerkesztői vezérlés és a hibatűrés közül.
- 3
A forrásrekord hozzárendelése egy különálló nyelvi verziójú rekordhoz tartós csatolással.
- 4
Adjon hozzá hitelesítést, idempotenciát, újrapróbálkozást, gyorsítótár érvénytelenítését, naplózást és hozzáférés-vezérlést.
- 5
Tesztközzététel, forrásmódosítások, nem elérhető eredmények, visszaállítás, billentyűzetkezelés és figyelés a kiadás előtt.
Példa vagy eszköz
A teljes kérés és válasz pár tartalmazza a hitelesítést, a területi beállításokat, a módot, az idempotenciát és a hibakezelést. Az eszközben rögzítse az alapállapotot, a tulajdonost, a döntést, a bizonyítékot, a nyitott kiadást és a jóváhagyás dátumát is. Valódi oldalt vagy tranzakciót használjon, hogy a csapat láthassa a függőségeket, a kivételeket és a kiadást követő karbantartási munkát.
| Döntési pont | Rekord | Elfogadási kritérium |
|---|---|---|
| Alapvonal | Megfigyelt jelenlegi állapot | A felvétel forrása és dátuma |
| Döntés | A kiválasztott lehetőség és indoklás | Figyelembe vették a kockázatot és a közönséget |
| Bizonyíték | Teszteljen, dokumentáljon vagy mérjen | Áttekinthető és verzióspecifikus |
| Jóváhagyás | Név, szerep és dátum | Minden kötelező kritérium teljesült |
Egy gyártási formájú kérés küldése
Hozzon létre egy kiszolgálóoldali integrációs ügyfelet, és tárolja a hitelesítő adatait a titkos telepítési kezelőben. UTF-8 JSON küldése HTTPS-en keresztül stabil forrásazonosítóval, forrásváltozattal, kért területi beállítással, nyelvi móddal és tartalomtörzsrel. Adjon hozzá egy idempotenciakulcsot, amely ugyanaz marad az azonos feladat újrapróbálásakor. Ne tegye ki a hitelesítő adatokat a böngészőkódban, a tárfájlokban, a CMS mezőkben, a képernyőképekben vagy az ügyfél által látható hibaválaszokban.
Kezdje egy reprezentatív, de nem érzékeny szolgáltatási oldallal. Tartalmazzon címsorokat, listákat, linkeket és jogi vagy működési feltételt, hogy a válasz érvényesítse a valódi tartalomszerződést. A API meghívása előtt utasítsa el az üres forrásazonosítót, a nem támogatott területi beállítást, az ismeretlen módot, a túlméretezett törzset vagy a hibás szerkezetet. Állítson be explicit kapcsolati és válaszidőkorlátot, és vigye el a korrelációs azonosítót az alkalmazásnaplókba.
| Kérelem mező | Cél | Érvényesítés |
|---|---|---|
| forrásazonosító | Tartós kapcsolat a CMS rekordhoz | Kötelező, stabil, nem személyes |
| forrásRevision | Érzékeli az elavult eredményeket | Kötelező és megváltoztathatatlan a kéréshez |
| nyelv és mód | Kiválasztja a nyelvi szabályokat | Engedélyezett kombinációnak kell lennie |
| idempotencyKey | Biztonságossá teszi az újrapróbálkozásokat | Ugyanaz a művelet ugyanazt a kulcsot használja |
Érvényesítse a teljes válaszadási szerződést
A sikeres HTTP állapotot csak az első ellenőrzésként kezelje. Érvényesítse a válaszsémát, az eredményazonosítót, a forrásazonosítót és -változatot, a területi beállítást, a nyelvi módot, a feldolgozási állapotot, a tartalomblokkokat, a figyelmeztetéseket és a modell vagy szabálykészlet verzióját, ha van. Az ismeretlen enumértékek és a hiányzó kötelező mezők áttekinthető integrációs hibába záródnak. A figyelmeztetéseket őrizze meg a vázlat mellett, mert azonosítani tudják a terminológiát, a forrásminőséget vagy a kézi ellenőrzés követelményeit.
Tárolja a generált kimenetet külön változat-tervezetként, ahelyett, hogy felülírná a jóváhagyott forrást. Rögzítse a kérés- és eredményazonosítókat, az átalakítási beállításokat, az időbélyegeket és a forrásváltozat integritás-kivonatát. Rendeljen különbséget a véleményezők számára, és meneküljön el minden kimenetről a cél szerint. A generált jelölés nem megbízható bemenet, amíg a séma ellenőrzése, tisztítása, hozzáférhetőségi ellenőrzése és emberi jóváhagyása be nem fejeződik.
- 1
Érvényesítse a kimenő hasznos terhelést egy helyi séma alapján.
- 2
Küldje el a kérést hitelesítési, időtúllépési, idempotencia és korrelációs fejlécekkel.
- 3
Érvényesítse az állapotot, a fejléceket és a válasz törzsét a rögzített szerződés alapján.
- 4
Hozzon létre egy külön CMS vázlatot, amely a pontos forrásváltozathoz kapcsolódik.
- 5
A figyelmeztetéseket és a diffeket a megfelelő szerkesztői felülvizsgálati sorba irányítsa.
Kezelje a hibákat a megkettőzés vagy a munka elvesztése nélkül
Csak akkor próbálja újra az időtúllépéseket, a kapcsolati hibákat és a sebességkorlátozásokat, ha a művelet idempotens. Használjon korlátozott exponenciális visszalépést rezgésekkel, és tartsa be a szerver által biztosított újrapróbálkozási késleltetést. Ne próbálkozzon újra érvényesítési hibákkal, hitelesítési hibákkal vagy nem támogatott beállításokkal a konfiguráció módosításáig. Helyezze a kimerült műveleteket egy holtbetűs sorba a forráshivatkozással, a biztonságos hibakategóriával, a kísérletek számával és a következő felelős csapattal.
Különítse el a felhasználói állapotot a diagnosztikai részletektől. A szerkesztőknek egyértelmű állapotokra van szükségük, mint például sorban állás, feldolgozás, vázlat készen áll, művelet szükséges és sikertelen egy biztonságos következő lépéssel. A műveletekhez kérésazonosítókra, időtartamra, állapotkategóriára és újrapróbálkozási előzményekre van szükség, de nem a teljes forrásszövegre a normál naplókban. Figyelmeztetés a tartós hibaarányról, a várakozási sorok korának növekedéséről, a hitelesítési hibákról, a séma eltéréseiről és a feldolgozás során megváltozott forrásváltozatokról.
Minden újrapróbálható műveletnek van egy stabil idempotencia kulcsa.
A visszalépés korlátozva van, és tiszteletben tartja a sebességkorlátozási utasításokat.
A naplók nem tartalmazzák a hitelesítő adatokat és a szükségtelen tartalomtörzseket.
A holtbetűs tételeknek tulajdonosa és visszajátszási eljárása van.
Egy elavult eredmény nem helyettesítheti csendben az újabb forrásváltozatot.
Kiadás előtt igazolja az integrációt
Tesztelje az érvényes kéréseket, minden dokumentált érvényesítési hibát, lejárt és visszavont hitelesítő adatokat, időtúllépéseket, sebességkorlátokat, ismétlődő beküldést, soron kívüli befejezést, sémafejlődést, tisztítást és forrásváltozásokat a feldolgozás során. Győződjön meg arról, hogy a felügyelet minden hibát azonosít, és hogy egy képzett kezelő újra le tudja játszani vagy bezárja az elemet adatbázis szerkesztése nélkül. Futtassa a kisegítő lehetőségeket és a szerkesztői áttekintést a megjelenített piszkozaton, ne csak a nyers válaszon.
Kiadás korlátozott hitelesítési adatokkal, meghatározott kamat- és költési korlátokkal, irányítópultokkal, figyelmeztető tulajdonjoggal és visszaállítási kapcsolóval, amely leállítja az új generációt a közzétett tartalom befolyásolása nélkül. Rögzítse a támogatott szerződéses verziót, és ütemezze be a frissítés felülvizsgálatát. A gyártási átvételi jegyzőkönyvnek tartalmaznia kell a vizsgálati bizonyítékokat, a biztonsági jóváhagyást, az adatfolyam-dokumentációt, a lektori aláírást, a kezelési utasításokat és egy szándékosan meghiúsult feladat sikeres helyreállítását.
Szerepek, bizonyítékok és jóváhagyás
A generálást tartsa külön a közzétételtől. A sikeres válasz tervezet, nem jóváhagyás. Tárolja a forrásazonosítót és verziót, az átalakítási beállításokat, az eredményazonosítót, a felülvizsgálati állapotot, a jóváhagyót és a közzétételi időt. Amikor a forrás megváltozik, a jóváhagyott tartalom csendes cseréje helyett jelölje meg a nyelvi verziót felülvizsgálatra. Ez lehetővé teszi a visszaállítást és az auditálást a platformok között.
Műveletek és karbantartás
A munka nem ér véget a megjelenéssel. Kapcsolja össze a nyelvi verziót vagy konfigurációt a forrásával, figyelje a minőségi és szolgáltatási intézkedéseket, és határozzon meg konkrét felülvizsgálati indítékokat. A kiváltó tényezők közé tartoznak a forrásváltozások, a jogi változások, az új közönségigények, az ismétlődő támogatási kérdések, a technikai változások és az incidensek. Egy megnevezett tulajdonos értékeli az eseményindítót, szükség esetén új verziót nyit meg, és rögzíti a megújított jóváhagyást.
Közzétételi ellenőrzőlista
Az integráció tartós forrásazonosítókat használ.
A hitelesítő adatokat a rendszer a szerver oldalon tárolja és elforgatja.
Meg van határozva az időtúllépés, az újrapróbálkozás és a sebességkorlátozás viselkedése.
Az ismételt kérések idempotensek.
A generált tartalom felülvizsgálati állapotba kerül.
A forrásmódosítások érvénytelenítik vagy újra megnyitják a verziót.
A nyelvi navigáció billentyűzettel és kisegítő technológiával működik.
A figyelés kiterjed a hibákra, a várólistákra, a várakozási időre és az elavult tartalomra.