Apidoc: Les exemples de requêtes d'API envoient les paramètres sous forme de chaîne vide

Créé le 23 janv. 2015 · 7Commentaires · Source: apidoc/apidoc

Lorsque vous utilisez sampleUrl pour générer des formulaires pour tester les méthodes de l'API, les pages apidoc envoient tous les paramètres du groupe de paramètres actuellement sélectionné aux points de terminaison de l'API, même si l'utilisateur n'a rempli aucune valeur.

Par exemple, si j'ai une méthode avec 3 paramètres, a , b et c , tous facultatifs, et que je ne remplis qu'une valeur dans a , en cliquant sur Send , apidoc envoie une requête avec la valeur que j'ai entrée pour a et des chaînes vides comme valeurs pour b et c .

Ce n'est pas souhaitable et casse les API qui n'acceptent pas les chaînes vides comme valeurs pour ces paramètres. Ces exemples de formulaires ne doivent envoyer que les paramètres spécifiquement fournis par l'utilisateur.

todo

Source

tnunes

👍3

Commentaire le plus utile

J'ai créé une demande d'extraction pour cette fonctionnalité ici https://github.com/apidoc/apidoc/pull/647 , bien que je pense personnellement que nous devrions inclure une case à cocher quelconque à côté des paramètres facultatifs qui indiquent qu'une chaîne vide devrait être envoyé pour les demandes d'échantillons dans le cas où vous voudriez réellement envoyer une chaîne vide.

tommybananas le 19 mai 2017

👍2

Tous les 7 commentaires

J'ai soumis un PR #193 qui, espérons-le, traitera ce problème (paramètres et en-têtes également).
Peut-être pourriez-vous y jeter un œil et donner votre avis au cas où j'aurais oublié quelque chose.

Merci

Vincent

vherilier le 23 janv. 2015

Je ne pense pas que votre demande d'extraction résolve ce problème, car elle n'empêche pas l'envoi de chaînes vides pour les paramètres facultatifs.

De plus, il est impossible de fournir des valeurs définies par l'utilisateur pour les champs obligatoires, car vous remplacez les valeurs par défaut, lorsqu'elles existent, sans vérifier si l'utilisation a fourni une valeur personnalisée.

Je ne pense pas non plus qu'apidoc devrait envoyer une valeur par défaut pour n'importe quel paramètre. IMO, lorsque vous documentez un paramètre d'API avec une valeur par défaut, vous décrivez ce que l'appel d'API assumera pour cette valeur lorsque vous n'en fournissez pas. Le client ne doit pas envoyer cette valeur, cela sera implicite.

tnunes le 23 janv. 2015

Désolé, j'ai raté quelque chose dans votre problème, et je ne résous pas votre problème. C'est vrai, mes excuses...

vherilier le 23 janv. 2015

Salut, y a-t-il une avancée à ce sujet ? J'essaie de définir une requête PUT et je ne veux pas mettre à jour les champs avec une chaîne vide, existe-t-il un moyen de dire à Apidoc de n'envoyer que les paramètres remplis ?