Comment nettoyer des exemples API copiés avant de les tester

Écrit par

dans

Les exemples API copiés depuis une documentation, un chat, un PDF ou un ticket peuvent échouer pour des raisons qui ne viennent pas de l’API. Guillemets typographiques, formatage caché, commentaires, retours ligne et placeholders peuvent casser la requête.

Commencez par JSON Formatter and Validator pour les payloads JSON. Utilisez Strip Markdown Formatting, Remove Non-ASCII, Remove Extra Spaces et Trim Text quand l’exemple contient du bruit.

Retirez l’enveloppe, gardez le payload

La documentation entoure souvent le payload de blocs code, commentaires ou explications. Séparez le corps réel de la requête du texte autour.

Remplacez les placeholders volontairement

Ne laissez pas YOUR_API_KEY, example.com ou de faux IDs dans un test. Remplacez-les un par un pour savoir ce qui change.

Validez avant l’envoi

Si le body est en JSON, validez-le avant d’appeler l’API. Une erreur de syntaxe locale est plus simple qu’une réponse API confuse.

Commentaires

Laisser un commentaire

Votre adresse e-mail ne sera pas publiée. Les champs obligatoires sont indiqués avec *