Selgitage ülesanne ja otsus
See juhend muudab API kiirkäivituse ülevaatavaks töövooks. See ühendab domeeniotsused, omandiõiguse, tõendid ja aktsepteerimise, nii et tulemus töötab tootmises edasi.
Alustage ühest autentitud päringust, kinnitage vastuseleping ja lisage enne CMS ühendamist rikete käsitlemine.
Praktiline töövoog
- 1
Varude allika tüübid, identifikaatorid, väljad, lokaadid, omanikud ja avaldamise olekud.
- 2
Valige tarnemuster helitugevuse, latentsuse, toimetuse juhtimise ja tõrketaluvuse hulgast.
- 3
Vastandage lähtekirje püsiva sidemega eraldi keeleversiooni kirjega.
- 4
Lisage autentimine, idempotentsus, uuesti proovimine, vahemälu kehtetuks tunnistamine, logimine ja juurdepääsu juhtelemendid.
- 5
Testi avaldamine, allika muudatused, kättesaamatud tulemused, tagasipööramine, klaviatuuri kasutamine ja jälgimine enne avaldamist.
Näide või tööriist
Täielik päringu ja vastuse paar sisaldab autentimist, lokaadi, režiimi, idempotentsust ja veakäsitlust. Tööriistas registreerige ka lähteseisund, omanik, otsus, tõendid, avatud probleem ja kinnitamise kuupäev. Kasutage päris lehte või tehingut, et meeskond näeks sõltuvusi, erandeid ja väljalaskmisele järgnevat hooldustööd.
| Otsustuspunkt | Salvestus | Vastuvõtmise kriteerium |
|---|---|---|
| Lähtejoon | Täheldatud hetkeseisu | Allikas ja salvestamise kuupäev |
| Otsus | Valitud variant ja põhjendus | Arvestatud on riski ja publikuga |
| Tõendid | Testige, dokumenteerige või mõõtke | Ülevaatav ja versioonipõhine |
| Heakskiit | Nimi, roll ja kuupäev | Kõik kohustuslikud kriteeriumid on täidetud |
Saada üks toodangukujuline päring
Looge serveripoolne integratsiooniklient ja salvestage selle mandaat juurutuse salahaldurisse. Saatke UTF-8 JSON HTTPS-i kaudu stabiilse allika identifikaatori, allika versiooni, taotletud lokaadi, keelerežiimi ja sisu kehaga. Lisage idempotentsuse võti, mis jääb samaks, kui identset tööd uuesti proovitakse. Ärge avaldage mandaate brauseri koodis, hoidlafailides, CMS väljades, ekraanipiltides ega kliendile nähtavates veavastustes.
Alustage esindusliku, kuid mittetundliku teeninduslehega. Kaasake pealkirjad, loendid, lingid ja õiguslik või tegevustingimus, et vastus järgiks tegelikku sisulepingut. Enne API helistamist lükake tagasi tühi allika identifikaator, toetamata lokaat, tundmatu režiim, liiga suur keha või vääratud struktuur. Määrake selge ühenduse ja vastuse ajalõpp ning levitage korrelatsiooniidentifikaator oma rakenduse logidesse.
| Taotluse väli | Eesmärk | Valideerimine |
|---|---|---|
| allika ID | Vastupidav link CMS plaadile | Nõutav, stabiilne, mitteisiklik |
| allikasRevision | Tuvastab aegunud tulemused | Taotluse jaoks nõutav ja muutumatu |
| lokaat ja režiim | Valib keelereeglid | Peab olema lubatud kombinatsioon |
| idempotencyKey | Muudab korduskatsed turvaliseks | Sama toiming kasutab sama klahvi |
Kinnitage täielik vastamisleping
Käsitlege edukat HTTP-olekut ainult esimese kontrollina. Kinnitage vastuseskeem, tulemuse identifikaator, allika identifikaator ja versioon, lokaat, keelerežiim, töötlemise olek, sisuplokid, hoiatused ja mudeli või reeglistiku versioon, kui need on saadaval. Tundmatud loendiväärtused ja puuduvad kohustuslikud väljad peaksid ebaõnnestuma ülevaatava integreerimisvea tõttu. Säilitage hoiatused mustandi kõrval, kuna need võivad tuvastada terminoloogia, allika kvaliteedi või käsitsi ülevaatamise nõuded.
Salvestage loodud väljund eraldi versioonina, mitte ei kirjuta kinnitatud allikat üle. Salvestage päringu ja tulemuste identifikaatorid, teisendussätted, ajatemplid ja lähteversiooni terviklikkuse räsi. Renderdage arvustajatele erinevus ja eemaldage kogu väljund vastavalt selle sihtkohale. Loodud märgistus on ebausaldusväärne sisend, kuni skeemi valideerimine, desinfitseerimine, juurdepääsetavuse kontrollimine ja inimeste kinnitus on lõpule viidud.
- 1
Kinnitage väljaminev kasulik koormus kohaliku skeemi alusel.
- 2
Saatke päring autentimise, ajalõpu, idempotentsuse ja korrelatsiooni päistega.
- 3
Kinnitage kinnitatud lepingu olek, päised ja vastuse keha.
- 4
Looge eraldi CMS mustand, mis on lingitud täpse allika versiooniga.
- 5
Suunake hoiatused ja diffid õigesse toimetuse arvustuste järjekorda.
Käsitsege vigu ilma dubleerimist või tööd kaotamata
Proovige uuesti ajalõppusid, ühenduse tõrkeid ja kiiruspiiranguid ainult siis, kui toiming on idempotentne. Kasutage piiratud eksponentsiaalset taganemist koos värinaga ja järgige serveri pakutavat uuesti proovimise viivitust. Ärge proovige uuesti valideerimise tõrgete, autentimise tõrgete või toetamata valikute korral enne konfiguratsiooni muutmist. Asetage ammendatud toimingud surnud tähe järjekorda koos allika viite, ohutu veakategooria, katsete arvu ja järgmise vastutava meeskonnaga.
Eraldage kasutajale suunatud olek diagnostika üksikasjadest. Toimetajad vajavad selgeid olekuid, nagu järjekord, töötlemine, mustand valmis, nõutav toiming ja turvaline järgmine samm ebaõnnestus. Toimingud vajavad päringu identifikaatoreid, kestust, olekukategooriat ja korduskatsete ajalugu, kuid mitte tavaliste logide täielikku lähteteksti. Hoiatus püsiva veamäära, kasvava järjekorra vanuse, autentimistõrgete, skeemi mittevastavuste ja mustandite kohta, mille allika redaktsioon töötlemise ajal muutus.
Igal uuesti proovitaval toimingul on stabiilne idempotentsuse võti.
Tagasivõtmine on piiratud ja järgib kiiruspiirangu juhiseid.
Logid välistavad mandaadid ja mittevajalikud sisukehad.
Surnud kirjaga esemetel on omanik ja taasesitamise protseduur.
Aegunud tulemus ei saa vaikselt asendada uuemat lähtekoodi versiooni.
Enne vabastamist tõestage integreerimist
Kontrollige kehtivaid taotlusi, iga dokumenteeritud valideerimisviga, aegunud ja kehtetuks tunnistatud mandaate, ajalõppe, määrapiiranguid, duplikaate, tellimusest väljasolevat lõpetamist, skeemi arengut, desinfitseerimist ja allika muudatusi töötlemise ajal. Veenduge, et jälgimine tuvastab iga tõrke ja koolitatud operaator saab üksuse uuesti esitada või sulgeda ilma andmebaasi redigeerimiseta. Käivitage juurdepääsetavus ja toimetaja ülevaade renderdatud mustandil, mitte ainult töötlemata vastusel.
Väljalase piiratud mandaadi, määratletud määra ja kululimiitide, armatuurlaudade, hoiatusteadete omandiõiguse ja tagasipööramislülitiga, mis peatab uue põlvkonna ilma avaldatud sisu mõjutamata. Kinnitage toetatud lepinguversioon ja ajatage versiooniuuenduse ülevaatus. Tootmise vastuvõtmise kirje peaks sisaldama katsetõendeid, turbekinnitust, andmevoo dokumentatsiooni, ülevaataja allkirjastamist, kasutusjuhiseid ja ühe tahtlikult ebaõnnestunud töö edukat taastamist.
Rollid, tõendid ja heakskiit
Hoidke genereerimine avaldamisest eraldi. Edukas vastus on mustand, mitte heakskiit. Salvestage allika identifikaator ja versioon, teisendusseaded, tulemuse identifikaator, ülevaatuse olek, kinnitaja ja avaldamise aeg. Kui allikas muutub, märkige heakskiidetud sisu vaikselt asendamise asemel ülevaatamiseks keeleversioon. See muudab tagasipööramise ja auditi võimalikuks platvormide lõikes.
Toimingud ja hooldus
Töö avaldamisega ei lõpe. Linkige keeleversioon või konfiguratsioon selle allikaga, jälgige kvaliteedi- ja teenindusmeetmeid ning määrake konkreetsed ülevaatuse käivitajad. Käivitajad hõlmavad allikamuudatusi, juriidilisi muudatusi, uusi vaatajaskonna vajadusi, korduvaid tugiküsimusi, tehnilisi muudatusi ja vahejuhtumeid. Nimega omanik hindab päästikut, avab vajaduse korral uue versiooni ja registreerib uuendatud kinnituse.
Avaldamise kontrollnimekiri
Integreerimine kasutab püsivaid allikaidentifikaatoreid.
Mandaadid salvestatakse serveri poole ja neid pööratakse.
Määratud on ajalõpp, uuesti proovimine ja kiiruspiirangu käitumine.
Korduvad taotlused on idempotentsed.
Loodud sisu läheb ülevaatuse olekusse.
Allika muudatused muudavad versiooni kehtetuks või avavad selle uuesti.
Keeles navigeerimine töötab klaviatuuri ja abitehnoloogia abil.
Järelevalve hõlmab tõrkeid, järjekordi, latentsust ja aegunud sisu.