Jokaisella JSON-tuotteella on oltava vakaa tunniste, yksilöllinen etana, julkaisupäivämäärä ja muutospäivämäärä. Tiedoston on myös ilmoitettava skeemaversionsa ja oma päivityspäivä.
Nämä kentät muodostavat ehdotetun toimituksellisen sopimuksen; JSON-standardi ei edellytä slugia eikä päivämäärää.
päätös tehdä ensin
versio Tiedot ja niiden rakenne. Valinnaisen kentän lisääminen on helppoa; Kentän uudelleennimeäminen tai poistaminen vaatii selkeän siirron, aseman ohjauksen ja todennettavissa olevan historian.
konkreettinen menetelmä
- Määritä muuttumaton otsikosta riippumaton tunniste.
- Säilytä julkaistut etanat tai valmistele uudelleenohjaus.
- Lajittele avaimet johdonmukaisesti saadaksesi luettavia eroja.
- Tarkista kaksoiskappaleet, tyypit ja päivämäärät ennen jokaista toimitusta.
- etiketti tärkeissä toimituksellisissa erissä.
pääloukku
Käytä tunnistetta uudelleen tai luo kaikki etanat uudelleen, aiheuttaa törmäyksiä, katkenneita linkkejä ja jäljitettävyyden menetystä. Artikkelin identiteetin ei pitäisi riippua muokattavasta kentästä.
Seuraava vaihe suositellaan
Kirjoita CLI-säädin, joka laskee artikkeleita, täplittää etanoita ja vahvistaa kunkin kielen vaaditut kentät.
Aiheen dokumentoidut viitekohdat
| Viite | Arvo tai syntaksi | Soveltamisala |
|---|---|---|
| RFC 8259 · JSON | application/json · UTF-8 | Tavallinen JSON ei salli kommentteja tai loppupilkkuja; merkkijonot käyttävät kaksinkertaisia lainausmerkkejä. |
| WordPress · Tools Export | WXR / XML | WordPressin sisältövienti voi sisältää artikkeleita, sivuja, sisältötyyppejä, kommentteja, mukautettuja kenttiä ja luokitteluja. Valitut suodattimet määräävät laajuuden. Tarkista mediatiedostot, teema, lisäosat ja asetukset erikseen ennen kuin pidät siirtoa täydellisenä. |
| HTTP · If-Match | If-Match: "r7" → 412 | If-Match vertaa vahvaa tunnistetta ennen kirjoitusta. Esimerkin sopimuksessa vanhentunut versio saa 412-vastauksen; luonnos säilytetään muutosten vertailuun. |
Päivämäärät kertovat lähteiden tarkistamisesta. Tiedot eivät ole sivuston auditointi tai yleinen vaatimustenmukaisuusvakuutus.
Tarkistusharjoitus: näyttö ennen päätöstä
Ehdotettu harjoitus valitussa laajuudessa, tarvittaessa kuvitteellisilla tiedoilla. Kirjaa havaintosi; esimerkki ei kuvaa sivustollasi jo tehtyä testiä.
- Kokeiltava toiminto
Korjaa työkopiossa JSON-artikkelin yksi virke säilyttäen tunniste. Vertaa tietoja ja generoi sivu uudelleen.
- Säilytettävä havaintoaineisto
Säilytä erot, JSON-jäsentimen tulos ja sivu. Tarkista otsikko, URL, suhteet ja viereinen sisältö.
- Mitä näyttö ei todista
Kelvollinen JSON voi sisältää asiavirheen. Vakaa tunniste ei takaa oikeaa julkaisua tai palautusta.
Muutos, joka kannattaa versioida
Ryhmä korjaa kahdessatoista JSON-artikkeleissa ilmoitetun vasteajan. Se päivittää lähdetietoa, tallentaa kaksitoista tunnuksen, joita asia koskee, ja tarkistaa sitten, että otsikoita, päivämääriä ja linkkejä ei ole muutettu vahingossa. Tiedostojen vertailu ennen julkaisua näyttää tarkalleen, mitä vastauksia muokattiin.
Pidä vakaa tunnus jokaiselle artikkelille ja vahvista JSON ennen käyttöönottoa. Yhden lauseen korjaus ei saa luoda uutta URL-osoitetta tai poistaa historiaa. Kirjaa muistiin, miksi muutos tehtiin ja kuka sen hyväksyi.