如何解决express-jsdoc-swagger _在request.body中使用枚举类型
我有一个字符串枚举类型的属性,我需要用swagger进行解释。所以这是我的示例:
/**
* A client
* @typedef {object} Client
* @property {string} uuid.required - unique id from client
* @property {string} os.required - os type - enum:mac,windows
* @property {integer} os_specifications.required - the version of the os
*/
/**
* POST /api/v1/client/register
* @summary register client
* @tags client
* @param {Client} request.body.required - client object for registration
* @return {object} 200 - success response - application/json
* @return {object} 403 - forbiden
*/
router.post('/register',async (req,res) => {
try {
let data = {
...req.body,role: 'client',};
let user = await UsersController.createClient({ ...data });
return res.status(200).json({ user: { ...user } });
} catch (error) {
logger.error(error);
res.status(403).json(error);
}
});
但是它告诉我这个:
{
"uuid": "string","os": "mac","os_specifications": 0
}
在官方documentation中,该示例使用以下代码:
* @param {string} name.query.required - name param description - enum:type1,type2
为什么这不适用于请求正文参数?
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。