公开定义的APIDoc定义
我正在Sails.js应用程序中使用apiDoc文档。 而且,上周我看到有人在一个名为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' }