Escaping je lako pogriješiti jer nekoliko različitih poslova iz daljine izgleda slično. Imate tekst, tekst sadrži posebne znakove i drugi sustav ga treba primiti bez pogrešnog tumačenja. Pogreška je pretpostaviti da jedna vrsta escape-a radi svugdje.
URL kodiranje, HTML escape i JSON escape rješavaju različite probleme. Razmak u query stringu nije isti problem kao znak < u renderiranom HTML-u ili navodnik unutar JSON stringa. Alat Case / Slug / Escape pomaže jer drži te outpute blizu, ali korisni dio je znati koji output pripada odredištu koje pripremate.
URL kodiranje je za URL-ove i query vrijednosti
Koristite URL kodiranje kada tekst ulazi u URL komponentu, posebno query parametar ili vrijednost koja može sadržavati razmake, interpunkciju ili znakove koji nisu sigurni za putanju.
Zamislite da support link treba uključiti pojam pretraživanja kao pricing & billing. Lijepljenje te fraze izravno u URL može promijeniti način na koji se URL tumači jer & već ima značenje unutar query stringa. URL kodiranje pretvara tekst u oblik koji može putovati unutar URL-a bez zabune s URL sintaksom.
To se razlikuje od stvaranja sluga. Slug obično pretvara naslov u čitljiv segment putanje, poput pricing-and-billing. URL kodiranje izravnije čuva izvornu vrijednost za prijenos.
HTML escape je za tekst koji će se renderirati u HTML-u
Koristite HTML escape kada se tekst treba pojaviti kao tekst unutar HTML konteksta, a ne postati markup.
Ako primjer koda uključuje <button> i želite da čitatelji vide te znakove, preglednik ih treba escapati. Inače ih može protumačiti kao stvarni element. HTML escape sprječava da se tekst čita kao HTML sintaksa na mjestima gdje sadržaj treba ostati vidljiv tekst.
To je važno u dokumentaciji, CMS poljima, changelozima i product copyju. Posebno je relevantno kada izvorni tekst uključuje primjere markupa, snippete ili korisnički generirane vrijednosti koje ne bi smjele postati dio strukture stranice.
JSON escape je za string vrijednosti unutar JSON-a
Koristite JSON escape kada tekst treba sigurno stajati unutar JSON stringa.
Navodnik je bezopasan u običnom tekstu, ali unutar JSON stringa može prerano zatvoriti string. Novi red također može trebati reprezentaciju koja JSON drži valjanim. JSON escape čuva vrijednost dok okolni JSON ostaje parsabilan.
To se često pojavljuje kada timovi dijele API primjere, konfiguracijske snippete, analytics payloadove ili uzorke podataka. Ako je sljedeći korak šire čišćenje strukturiranih podataka, povežite ovaj članak s Kako formatirati JSON prije dijeljenja API primjera i JSON / YAML / TOML konverterom.
Odaberite escaping prema odredištu
Najjednostavnije pravilo je prvo odredište.
| Odredište | Koristite | Zašto |
|---|---|---|
| URL query vrijednost ili URL komponenta | URL kodiranje | Sprječava da se tekst protumači kao URL sintaksa |
| Vidljiv tekst unutar HTML-a | HTML escape | Sprječava da posebni znakovi postanu markup |
| String vrijednost unutar JSON-a | JSON escape | Drži navodnike, slash znakove i prijelome redaka parsabilnima |
| Javni naslov članka ili rute | Generiranje sluga | Stvara čitljiv tekst putanje umjesto očuvanja svakog znaka |
Converty pomaže jer možete zalijepiti jednom i usporediti outpute bez otvaranja zasebnog encodera za svaki slučaj. To drži posao proporcionalnim. Ne gradite pipeline; pripremate jednu tekstualnu vrijednost za mjesto na koje treba ići.
Otvorite Case / Slug / Escape kada trebate odlučiti treba li sljedeći output biti slug, URL-kodirana vrijednost, HTML-safe tekst ili JSON-safe string.
