Il est facile de se tromper en s'échappant, car plusieurs emplois différents se ressemblent de loin. Vous avez du texte, le texte contient des caractères spéciaux et un autre système doit le recevoir sans le mal comprendre. L’erreur est de supposer qu’un seul type de fuite fonctionne partout.
Le codage d'URL, l'échappement HTML et l'échappement JSON résolvent différents problèmes. Un espace dans une chaîne de requête ne pose pas le même problème qu'un caractère < dans le rendu HTML ou un guillemet à l'intérieur d'une chaîne JSON. L'outil Case / Slug / Escape aide en gardant ces sorties proches les unes des autres, mais la partie utile est de savoir quelle sortie appartient à la destination que vous préparez.
L'encodage des URL concerne les URL et les valeurs de requête
Utilisez le codage d'URL lorsque du texte est envoyé dans un composant d'URL, en particulier un paramètre de requête ou une valeur pouvant contenir des espaces, des signes de ponctuation ou des caractères non sécurisés.
Supposons qu'un lien d'assistance doive inclure un terme de recherche tel que pricing & billing. Coller cette phrase directement dans une URL peut modifier la façon dont l'URL est interprétée, car & a déjà une signification dans une chaîne de requête. Le codage d'URL transforme le texte en un formulaire qui peut voyager à l'intérieur de l'URL sans être confondu avec la syntaxe de l'URL.
Ceci est différent de la création d'un slug. Un slug transforme généralement un titre en un segment de chemin lisible tel que pricing-and-billing. Le codage URL préserve la valeur d'origine plus directement pour le transport.
L'échappement HTML concerne le texte qui sera rendu en HTML
Utilisez l'échappement HTML lorsque le texte doit apparaître sous forme de texte dans un contexte HTML et non devenir un balisage.
Si un exemple de code inclut <button> et que vous souhaitez que les lecteurs voient ces caractères, le navigateur a besoin que les caractères soient échappés. Sinon, il pourrait les interpréter comme un élément réel. L'échappement HTML consiste à empêcher la lecture du texte en tant que syntaxe HTML aux endroits où le contenu doit rester du texte visible.
Cela compte dans la documentation, les champs CMS, les journaux des modifications et la copie du produit. Cela est particulièrement pertinent lorsque le texte source inclut des exemples de balises, d'extraits ou de valeurs générées par l'utilisateur qui ne doivent pas faire partie de la structure de la page.
L'échappement JSON concerne les valeurs de chaîne à l'intérieur de JSON
Utilisez l'échappement JSON lorsque le texte doit être placé en toute sécurité dans une chaîne JSON.
Un guillemet est inoffensif en prose normale, mais à l'intérieur d'une chaîne JSON, il peut fermer la chaîne plus tôt. Une nouvelle ligne peut également nécessiter une représentation qui maintient le JSON valide. L'échappement JSON consiste à préserver la valeur tout en gardant le JSON environnant analysable.
Cela apparaît souvent lorsque les équipes partagent des exemples d'API, des extraits de configuration, des charges utiles d'analyse ou des exemples de données. Si l'étape suivante consiste en un nettoyage plus large des données structurées, associez cet article à Comment formater JSON avant de partager un exemple d'API et le Convertisseur JSON/YAML/TOML.
Choisissez l'évasion en fonction de la destination
La règle la plus simple est la destination en premier.
| Destination | Utiliser | Pourquoi |
|---|---|---|
| Valeur de requête URL ou composant URL | Encodage d'URL | Empêche le texte d'être interprété comme une syntaxe d'URL |
| Texte visible dans HTML | HTML s'échappant | Empêche les caractères spéciaux de devenir du balisage |
| Valeur de chaîne dans JSON | JSON s'échappant | Conserve les guillemets, les barres obliques et les sauts de ligne analysables |
| Article public ou titre de l'itinéraire | Slug génération | Crée un texte de chemin lisible plutôt que de conserver chaque caractère |
Converty est utile car vous pouvez coller une fois et comparer les sorties sans ouvrir un encodeur séparé pour chaque cas. Cela maintient le travail proportionné. Vous ne construisez pas un pipeline ; vous préparez une valeur de texte pour l'endroit où elle doit aller.
Ouvrez l'outil Case / Slug / Escape lorsque vous devez décider si la sortie suivante doit être un slug, une valeur codée en URL, un texte sécurisé HTML ou une chaîne sécurisée JSON.
