Att fly är lätt att få fel eftersom flera olika jobb ser likadana ut på avstånd. Du har text, texten innehåller specialtecken och ett annat system måste ta emot det utan att missförstå det. Felet är att anta att en typ av flykt fungerar överallt.
URL-kodning, HTML-escape och JSON-escape löser olika problem. Ett blanksteg i en frågesträng är inte samma problem som ett <-tecken i renderad HTML eller ett citattecken inuti en JSON-sträng. Verktyget Case / Slug / Escape hjälper till att hålla dessa utdata nära varandra, men den användbara delen är att veta vilken utdata som hör till destinationen du förbereder.
URL-kodning är för webbadresser och frågevärden
Använd URL-kodning när text hamnar i en URL-komponent, särskilt en frågeparameter eller ett värde som kan innehålla mellanslag, skiljetecken eller icke-sökvägssäkra tecken.
Anta att en supportlänk måste innehålla en sökterm som pricing & billing. Att klistra in den frasen direkt i en webbadress kan ändra hur webbadressen tolkas eftersom & redan har betydelse i en frågesträng. URL-kodning förvandlar texten till en form som kan resa inuti URL:en utan att förväxlas med URL-syntax.
Detta skiljer sig från att skapa en slug. En slug förvandlar vanligtvis en titel till ett läsbart sökvägssegment som pricing-and-billing. URL-kodning bevarar det ursprungliga värdet mer direkt för transport.
HTML-escape är för text som kommer att renderas i HTML
Använd HTML-escape när text måste visas som text i en HTML-kontext, inte bli markering.
Om ett kodexempel innehåller <button> och du vill att läsarna ska se dessa tecken, behöver webbläsaren escape-tecknen. Annars kan det tolka dem som ett verkligt element. HTML-escape handlar om att förhindra att text läses som HTML-syntax på platser där innehållet ska förbli synlig text.
Det är viktigt i dokumentation, CMS-fält, ändringsloggar och produktkopia. Det är särskilt relevant när källtexten innehåller exempel på uppmärkning, kodavsnitt eller användargenererade värden som inte ska ingå i sidstrukturen.
JSON escaping är för strängvärden inuti JSON
Använd JSON-escape när text måste sitta säkert inuti en JSON-sträng.
Ett citattecken är ofarligt i normal prosa, men inuti en JSON-sträng kan det stänga strängen tidigt. En ny rad kan också behöva representation som håller JSON giltig. JSON escaping handlar om att bevara värdet samtidigt som den omgivande JSON kan analyseras.
Detta visas ofta när team delar API-exempel, konfigurationskodavsnitt, analysnyttolaster eller exempeldata. Om nästa steg är en bredare strukturerad datarensning, koppla ihop den här artikeln med Hur man formaterar JSON innan du delar ett API-exempel och JSON/YAML/TOML-konverteraren.
Välj escape baserat på destinationen
Den enklaste regeln är destination först.
| Destination | Använda | Varför |
|---|---|---|
| URL-frågevärde eller URL-komponent | URL-kodning | Förhindrar att text tolkas som URL-syntax |
| Synlig text i HTML | HTML flyktar | Förhindrar att specialtecken blir markeringar |
| Strängvärde inuti JSON | JSON flyr | Håller citattecken, snedstreck och radbrytningar tolkbara |
| Offentlig artikel eller rutttitel | Slug generation | Skapar läsbar sökvägstext istället för att bevara varje tecken |
Converty hjälper eftersom du kan klistra in en gång och jämföra utdata utan att öppna en separat kodare för varje fall. Det håller jobbet proportionellt. Du bygger inte en pipeline; du förbereder ett textvärde för platsen det behöver gå till.
Öppna verktyget Case / Slug / Escape när du behöver bestämma om nästa utdata ska vara en slug, ett URL-kodat värde, HTML-säker text eller en JSON-säker sträng.
