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不排除排除模式

相关内容

热门资讯

一分钟了解(wopoker)外... 一分钟了解(wopoker)外挂透明挂辅助软件(软件透明挂)一般真的有挂(2023已更新)(小红书)...
推荐十款(wepoke)外挂透... 推荐十款(wepoke)外挂透明挂辅助安装(智能ai代打)的确是有挂的(2020已更新)(百度)1、...
科普(WepokE)外挂透明挂... 科普(WepokE)外挂透明挂辅助插件(透视辅助)的确是有挂的(2025已更新)(头条)1、起透看视...
最新研发(wpK)外挂透明挂辅... 最新研发(wpK)外挂透明挂辅助工具(透视)就是真的有挂(2022已更新)(小红书)1、系统规律教程...
重大推荐(云扑克app)外挂透... 重大推荐(云扑克app)外挂透明挂辅助脚本(软件透明挂)总是真的有挂(2020已更新)(百度)辅助器...
必备科技(poker worl... 必备科技(poker world)外挂透明挂辅助器(透视辅助)都是真的有挂(2024已更新)(微博热...
重大推荐(we辅助poker)... 重大推荐(we辅助poker)外挂透明挂辅助脚本(透视辅助)一贯真的有挂(2023已更新)(百度)w...
一分钟了解(来玩德州)外挂透明... 一分钟了解(来玩德州)外挂透明挂辅助插件(透视辅助)原来真的有挂(2025已更新)(微博热搜)1、一...
一分钟了解(轰趴大菠萝)外挂透... 一分钟了解(轰趴大菠萝)外挂透明挂辅助安装(辅助挂)原来真的有挂(2022已更新)(知乎)1、每一步...
玩家必用(AAPOKEr)外挂... 玩家必用(AAPOKEr)外挂透明挂辅助工具(智能ai代打)果然真的有挂(2021已更新)(今日头条...