Laboratoire de sérialisation des paramètres OpenAPI

Prévisualisez comment les paramètres de chemin, de requête, d'en-tête et de cookie OpenAPI sont sérialisés en fonction des paramètres de style et d'éclatement, localement.

Collez ou choisissez un document OpenAPI 3.0, 3.1 ou 3.2, inspectez-le, sélectionnez une opération de chemin et ajustez la valeur de chaque paramètre JSON. Prévisualisez le chemin, la chaîne de requête, les en-têtes et les cookies, puis copiez les parties dont vous avez besoin.

Chargez un document OpenAPI, choisissez une opération, puis prévisualisez comment ses paramètres deviennent une cible de requête, des en-têtes et des cookies. Aucune demande n'est envoyée.

Collez JSON ou YAML ci-dessous, ou choisissez un fichier.

Jusqu'à 2 Mo et 300 opérations de chemin. Prend en charge OpenAPI 3.0, 3.1 et 3.2. Les références externes ne sont pas récupérées.

Comment utiliser

Vérifier comment un paramètre API apparaît sur le fil

Prévisualisez comment les paramètres de chemin, de requête, d'en-tête et de cookie OpenAPI sont sérialisés en fonction des paramètres de style et d'éclatement, localement.

Étapes à suivre

  1. Fournissez la source avec : Spécification OpenAPI.
  2. Lancez : Inspecter les spécifications. Examinez le résultat avant de le copier, télécharger ou utiliser ailleurs.
  3. Réglez : Opération de chemin. Utilisez le tableau pour choisir les options adaptées à votre tâche.
  4. Lancez : Aperçu de la sérialisation. Examinez le résultat avant de le copier, télécharger ou utiliser ailleurs.
  5. Collez ou choisissez un document OpenAPI 3.0, 3.1 ou 3.2, inspectez-le, sélectionnez une opération de chemin et ajustez la valeur de chaque paramètre JSON. Prévisualisez le chemin, la chaîne de requête, les en-têtes et les cookies, puis copiez les parties dont vous avez besoin.

Choisir les réglages

OptionCe qui change
Opération de cheminIl applique le style OpenAPI et les paramètres d'éclatement aux paramètres de chemin, de requête, d'en-tête et de cookie. Les styles courants pris en charge incluent simple, label, matrice, formulaire, spaceDelimited, pipeDelimited et deepObject.
Aperçu de la sérialisationLes paramètres basés sur le contenu, les tableaux ou objets imbriqués, les combinaisons de styles non définies et les références externes ne sont pas devinés. Les valeurs d'en-tête sont affichées sans codage URI car les règles de citation d'en-tête dépendent de l'en-tête. Le schéma n'est pas validé.

Exemple et résultat attendu

Pour GET /users/{id}, un tableau de requêtes `tag: [api, local]` avec `style: form` et `explode: true` devient `tag=api&tag=local`. Une valeur de chemin scalaire est codée avant d’être insérée dans le chemin. L'outil ne valide pas le schéma ni n'envoie de requête ; les encodages de contenu non pris en charge, les valeurs imbriquées et les références externes sont laissés pour examen manuel.

Si cela ne fonctionne pas

  • Les paramètres basés sur le contenu, les tableaux ou objets imbriqués, les combinaisons de styles non définies et les références externes ne sont pas devinés. Les valeurs d'en-tête sont affichées sans codage URI car les règles de citation d'en-tête dépendent de l'en-tête. Le schéma n'est pas validé.
  • Non. L'outil crée uniquement un aperçu local pour l'opération sélectionnée. Il ne résout pas les serveurs, n'ajoute pas d'authentification et n'envoie pas de requêtes réseau.
  • Si l’analyse échoue, vérifiez la syntaxe JSON ou YAML avant les résultats API. Placez les références locales nécessaires dans le même document. Les références externes non résolues et les schémas non pris en charge exigent une revue manuelle ; l’outil ne les télécharge pas et ne teste pas de serveur.

Que sérialise cet outil ?

Il applique le style OpenAPI et les paramètres d'éclatement aux paramètres de chemin, de requête, d'en-tête et de cookie. Les styles courants pris en charge incluent simple, label, matrice, formulaire, spaceDelimited, pipeDelimited et deepObject.

Qu'est-ce qui nécessite une révision manuelle ?

Les paramètres basés sur le contenu, les tableaux ou objets imbriqués, les combinaisons de styles non définies et les références externes ne sont pas devinés. Les valeurs d'en-tête sont affichées sans codage URI car les règles de citation d'en-tête dépendent de l'en-tête. Le schéma n'est pas validé.

Est-ce qu'il appelle l'API ?

Non. L'outil crée uniquement un aperçu local pour l'opération sélectionnée. Il ne résout pas les serveurs, n'ajoute pas d'authentification et n'envoie pas de requêtes réseau.