Apidoc: @apiBody and @apiQuery are not rendering.

Created on 20 Apr 2021  路  3Comments  路  Source: apidoc/apidoc

Bug Description

I am trying to write a Query and Body parameters for my apiDoc, however both @apiBody and @apiQuery don't show up in the index.html file when opened in the browser.

I ran apiDoc and generated the documentation, and the rest of the stuff works fine. only those two don't show up.

Steps to reproduce

/**
 * 
 * @api {POST} /auth/signUp signUp
 * @apiGroup auth
 * @apiVersion  0.1.0
 * 
 * 
 * @apiQuery {Number} id Users unique ID.
 * 
 * @apiBody {Number} id Users unique ID.
 * 
 */
  • Version of apidoc: 0.27.1
  • Operating system : Ubuntu 20.04
  • Browser : Brave, firefox

Most helpful comment

There is a work around for this, you can write this instead

..
..
..
@apiParam (Query) {Number} id Users unique ID. // instead of @apiQuery ...

@apiParam (Body) {Number} id Users unique ID. // instead of @apiBody ...

This is not written on the page apidocjs.com unlike @apiQuery {Number} id Users unique ID. which is specified on the website. so, I'm not sure if this is the intended way to write these.

All 3 comments

There is a work around for this, you can write this instead

..
..
..
@apiParam (Query) {Number} id Users unique ID. // instead of @apiQuery ...

@apiParam (Body) {Number} id Users unique ID. // instead of @apiBody ...

This is not written on the page apidocjs.com unlike @apiQuery {Number} id Users unique ID. which is specified on the website. so, I'm not sure if this is the intended way to write these.

Same issue with me. @apiBody is not working. Btw, thanks @Abdelrhman-Hosny for your work around.

This issue is duplicate with my issue #952

Was this page helpful?
0 / 5 - 0 ratings

Related issues

tnunes picture tnunes  路  7Comments

tyranron picture tyranron  路  3Comments

ivan-kleshnin picture ivan-kleshnin  路  5Comments

YannDoW picture YannDoW  路  4Comments

whitelujx picture whitelujx  路  3Comments