可选择将查询参数分组或添加额外属性
作者: jerrens创建于 2022年12月7日更新于 2023年10月18日
在我的 REST API 中,有一个参数仅可供"管理员"用户使用(其他用户可使用)。 我想在 API 文档中包含此参数,但我没有看到除了在描述中添加内容以外的其他选项。 @apiParam 的 group 属性看起来适合我的需求,如果它也可用于 @apiQuery。 然后我可以这样做: @apiQuery(AdminOnly) {number} field 此查询参数仅供管理员用户使用
假设我还可以通过 @apiDefine 条目设置组标题和描述
内容来源: apidoc/apidoc