Å rømme er lett å ta feil fordi flere forskjellige jobber ligner på avstand. Du har tekst, teksten inneholder spesialtegn, og et annet system må motta den uten å misforstå den. Feilen er å anta at én form for rømming fungerer overalt.
URL-koding, HTML-escape og JSON-escape løser forskjellige problemer. Et mellomrom i en søkestreng er ikke det samme problemet som et <-tegn i gjengitt HTML eller et anførselstegn inne i en JSON-streng. Verktøyet Case / Slug / Escape hjelper ved å holde disse utdataene tett sammen, men den nyttige delen er å vite hvilken utgang som tilhører destinasjonen du forbereder.
URL-koding er for URL-er og spørringsverdier
Bruk URL-koding når tekst går inn i en URL-komponent, spesielt en søkeparameter eller en verdi som kan inneholde mellomrom, tegnsetting eller ikke-stisikre tegn.
Anta at en støttekobling må inneholde et søkeord som pricing & billing. Hvis du limer inn den setningen direkte i en nettadresse, kan det endre hvordan nettadressen tolkes fordi & allerede har betydning i en søkestreng. URL-koding gjør teksten til et skjema som kan bevege seg inne i URL-en uten å bli forvirret for URL-syntaks.
Dette er forskjellig fra å opprette en slug. En slug gjør vanligvis en tittel til et lesbart banesegment, for eksempel pricing-and-billing. URL-koding bevarer den opprinnelige verdien mer direkte for transport.
HTML-escape er for tekst som vil bli gjengitt i HTML
Bruk HTML-escape når tekst må vises som tekst i en HTML-kontekst, ikke bli markering.
Hvis et kodeeksempel inkluderer <button> og du vil at leserne skal se disse tegnene, trenger nettleseren tegnene escaped. Ellers kan det tolke dem som et faktisk element. HTML-escape handler om å forhindre at tekst leses som HTML-syntaks på steder hvor innholdet skal forbli synlig tekst.
Det er viktig i dokumentasjon, CMS-felt, endringslogger og produktkopi. Det er spesielt relevant når kildeteksten inneholder eksempler på markeringer, utdrag eller brukergenererte verdier som ikke skal bli en del av sidestrukturen.
JSON-escape er for strengverdier inne i JSON
Bruk JSON-escape når tekst må sitte trygt inne i en JSON-streng.
Et anførselstegn er ufarlig i vanlig prosa, men inne i en JSON-streng kan det lukke strengen tidlig. En ny linje kan også trenge representasjon som holder JSON gyldig. JSON-escape handler om å bevare verdien samtidig som den omkringliggende JSON-en kan analyseres.
Dette vises ofte når team deler API-eksempler, konfigurasjonsbiter, analysenyttelaster eller eksempeldata. Hvis neste trinn er bredere strukturert dataopprydding, parer du denne artikkelen med How to Format JSON Before Sharing an API Eksempel og JSON / YAML / TOML Converter.
Velg escape basert på destinasjonen
Den enkleste regelen er destinasjon først.
| Destinasjon | Bruk | Hvorfor |
|---|---|---|
| URL-søkeverdi eller URL-komponent | URL-koding | Forhindrer at tekst tolkes som URL-syntaks |
| Synlig tekst i HTML | HTML unnslipper | Holder spesialtegn fra å bli markering |
| Strengverdi inne i JSON | JSON unnslipper | Holder anførselstegn, skråstreker og linjeskift analyserbare |
| Offentlig artikkel eller rutetittel | Slug generasjon | Skaper lesbar banetekst i stedet for å bevare hvert tegn |
Converty hjelper fordi du kan lime inn én gang og sammenligne utdataene uten å åpne en separat koder for hvert tilfelle. Det holder jobben proporsjonal. Du bygger ikke en rørledning; du forbereder én tekstverdi for stedet den skal til.
Åpne Case / Slug / Escape-verktøyet når du må bestemme om neste utdata skal være en slug, en URL-kodet verdi, HTML-sikker tekst eller en JSON-sikker streng.
