Apidoc: Corps de la requête avec tableau

Créé le 11 nov. 2016  ·  7Commentaires  ·  Source: apidoc/apidoc

Salut!

Comment pourrais-je documenter cela ?

POST /batch-insert
[
  { "name": "Name 1" },
  { "name": "Name 2" }
]

Je comprends que @apiParam peut être utilisé pour documenter le corps de la demande, mais <strong i="10">@apiParam</strong> {String[]} name implique { "name": ["Name 1", "Name 2"] } je pense.

enhancement

Commentaire le plus utile

@kok-ng Ce que vous décrivez est une API différente. La documentation que vous avez définie décrirait une demande de :

{
    names: [{ "name": "Name 1" }, { "name": "Name 2" }] 
}

Mais ce que (je crois) @Znarkus demandait, et ce que je cherchais aussi, c'est comment documenter une API qui attend :

 [{ "name": "Name 1" }, { "name": "Name 2" }]

PS Ceci est particulièrement pertinent si vous utilisez la fonction APIDoc où vous la faites générer des formulaires pour chaque point de terminaison. Actuellement, il est impossible d'obtenir APIDoc pour générer un formulaire pour un point de terminaison à moins que ce point de terminaison ne prenne des paramètres nommés (c'est-à-dire prend un objet, pas un tableau).

Tous les 7 commentaires

Je ressens ta douleur.
Tant qu'une solution n'est pas implémentée, j'utilise un trait de soulignement :
* <strong i="7">@apiParam</strong> {Object[]} _ array of objects with:

Il garde l'api assez lisible...

hey @dfreire que fait le _ ?

Rien. Il s'agit simplement d'un espace réservé facile à lire sur la sortie de la documentation.

Salut,
Si vous utilisez quelque chose comme

 * <strong i="7">@apiParam</strong> {Object[]} [names] A serie of names
 * <strong i="8">@apiParam</strong> {Object} [names.name] A name

Il produit un document assez clair et indenté, mais il ne l'envoie pas correctement avec apiSampleUrl.

@kok-ng Ce que vous décrivez est une API différente. La documentation que vous avez définie décrirait une demande de :

{
    names: [{ "name": "Name 1" }, { "name": "Name 2" }] 
}

Mais ce que (je crois) @Znarkus demandait, et ce que je cherchais aussi, c'est comment documenter une API qui attend :

 [{ "name": "Name 1" }, { "name": "Name 2" }]

PS Ceci est particulièrement pertinent si vous utilisez la fonction APIDoc où vous la faites générer des formulaires pour chaque point de terminaison. Actuellement, il est impossible d'obtenir APIDoc pour générer un formulaire pour un point de terminaison à moins que ce point de terminaison ne prenne des paramètres nommés (c'est-à-dire prend un objet, pas un tableau).

Une mise à jour sur celui-ci?

@fedemengo Non, mais vous pouvez contribuer ! ;)

Récemment, beaucoup de travail a été fait pour réduire le nombre de RP/questions ouvertes. Ce problème sera traité ultérieurement. À l'heure actuelle, les problèmes qui ne sont pas des bogues ont une priorité inférieure.

Cette page vous a été utile?
0 / 5 - 0 notes

Questions connexes

OsoianMarcel picture OsoianMarcel  ·  6Commentaires

ameliariely picture ameliariely  ·  7Commentaires

whitelujx picture whitelujx  ·  3Commentaires

njwest picture njwest  ·  4Commentaires

WilsonFpz picture WilsonFpz  ·  5Commentaires