Публично определенные определения APIDoc

Я использую apiDoc для документации в приложении Sails.js. И на прошлой неделе я видел, как кто-то определил ответы, используемые несколькими контроллерами в файле с именем api_definitions.js

пример

/*
* @apiDefine UserSuccessExample
* @apiSuccessExample Success-Response:
*     HTTP/1.1 201 OK
* {
*   "message": "User Created successfully",
*   "user" : {
*       "displayname": "somedisplayname",
*       "lastname": "ALastName",
*       "firstname": "AFirstName",
*       "email": "sososo@soos.so",
*       "phonenumber": "0839293288"
*   },
*   "token" : "ey.jkernekrerkerkeekwewekwbejwbewbebewbwkebebbwbeibwubfebfebwiee"
* }
*/

И в каждом из контроллеров ссылался на него с помощью обычного параметра использования @apiUse UserSuccessExample, Но когда я попробовал это, я получил ошибку в своей консоли, говорящую, это не было определено:

ошибка

error: Referenced groupname does not exist / it is not defined with @apiDefine.
{ File: 'api/controllers/UserController.js',
  Block: 2,
  Element: '@apiUse',
  Groupname: 'UserSuccessExample',
  Definition: '@apiUse group',
  Example: '@apiDefine MyValidGroup Some title\n@apiUse MyValidGroup' }

0 ответов

Другие вопросы по тегам