apidoc.js生成的文档中缺少required字段的说明 _程序开发

apidoc.js生成的文档中缺少required字段的说明

创始人

2024-09-07 12:30:24

0次

在文档注释中使用@apiParam标签，并在其后面添加“{必填}”或“{required}”，以明确参数是否为必填项。例如：

/**
 * @api {post} /user/add 添加用户
 * @apiName addUser
 * @apiGroup User
 *
 * @apiParam {String} name 用户名{必填}
 * @apiParam {String} email 邮箱{required}
 *
 * @apiSuccess {String} message 操作结果信息
 */

这样生成的文档就能清晰的显示每个参数是否为必填项。

上一篇：Apidoc - Node.js不显示@apiName

下一篇：apidoc不排除排除模式

热门资讯

今日科普!wepoke智能ai... 今日科普!wepoke智能ai(辅助挂)透视辅助机制(2024已更新)(哔哩哔哩)1、下载好wepo...

四分钟科普！哈狗游戏十三道辅助... 四分钟科普！哈狗游戏十三道辅助器，搜圈麻将假假，2024教程（证实有挂）是一款可以让一直输的玩家，快...

五分钟了解！雀友会潮汕麻将透明... 五分钟了解！雀友会潮汕麻将透明挂，广东雀神智能辅助器下载，黑科技教程（果真有挂）;一、雀友会潮汕麻将...

来一盘(微扑克开发)外挂透视辅... 1、来一盘(微扑克开发)外挂透视辅助app(辅助挂)辅助透视(2021已更新)(哔哩哔哩)（UU p...

免费测试版!wopoker手机... 自定义poker系统规律，只需要输入自己想要的开挂功能，一键便可以生成出微扑克专用辅助器，不管你是想...

十分钟科普！乐玩灵丘麻将有挂，... 十分钟科普！乐玩灵丘麻将有挂，功夫川麻辅助器v3.5.4，第三方教程（有挂方针）是一款可以让一直输的...

推荐一款！决战十三水ios版辅... 推荐一款！决战十三水ios版辅助器，全民雀神云南临沧下载，解密教程（有挂解密）;1分钟了解详细教程（...

关于(Wepoke合作)外挂透... 关于(Wepoke合作)外挂透视辅助器安装(辅助挂)软件透明挂(2025已更新)(哔哩哔哩)；是一款...

1分钟了解!wpk微扑克模拟器... 1、1分钟了解!wpk微扑克模拟器(辅助挂)原来确实真的有挂2022已更新)(哔哩哔哩)2、进入游戏...

十分钟普及！廉江钱柜手游可以开... 十分钟普及！廉江钱柜手游可以开挂，楚天游赤壁打滚辅助器，AI教程（确实有挂）1、每个玩家都可以进行使...

apidoc.js生成的文档中缺少required字段的说明

相关内容

热门资讯