API Doc apiGroup и apiName не работают должным образом

Это мое первое использование apiDocs, и я точно следую предоставленной документации.
Проблема в том, что я определяю apiName и apiGroup, но в выводе отображается только apiGroup.
Это мое определение:

/**
* @apiVersion 1.0.0
* @api {post} /users/register
* @apiGroup users
* @apiName register
* @apiDescription Register new user
* @apiParam {String} userName User email address
* @apiParam {String} passWord User password
* @apiSuccess {json} response error, message
* @apiSuccessExample {json} Success-Response:
*     HTTP/1.1 200 OK
*     {
*       "error": false,
*       "message": "USER_CREATED_SUCCESSFULLY"*     }
* @apiError {json} error error, message
* @apiErrorExample {json} Error-USER_CREATE_FAILED:
*     HTTP/1.1 200 Error creating user
*     {
*       "error": true
*      ,"message" : "USER_CREATE_FAILED"*     }
*/

Это мой apidoc.json:

{
"name": "T-Rex",
"version": "1.0.0",
"description": "API Document",
"title": "T-Rex",
"url": "https://apiusr.t-rex.io",
"template": {
"withCompare": true,
"withGenerator": true
}
}

Но список вывода только имя группы, игнорируя apiName:

users //apiGroup, it's ok

users //Should be @apiName, but showing the group

Delete user device association //@apiDescription, ok

Остальная часть вывода в порядке.

0

Решение

Я думаю, я нашел, как это работает!
Попробуйте с этим:

/**
* @apiVersion 1.0.0
* @api {post} /users/register Register
* @apiGroup users
* @apiName PostRegister

В основном @api Ключевое слово имеет три параметра:

  1. метод HTTP (пост)
  2. маршрут API (/ users / register)
  3. Название маршрута (Регистрация)

Тогда в @apiName вам нужно указать уникальную ссылку для этого маршрута, которая затем будет вставлена ​​в HTML-код, и, следуя документу, было бы лучше, если бы он начинался с имени метода HTTP.

1

Другие решения

Других решений пока нет …

По вопросам рекламы ammmcru@yandex.ru
Adblock
detector