如何在api-doc中设置数组响应？

Question

我尝试按apidoc

生成API文档

如果我的回复是像

这样的数组

[
   {"id" : 1, "name" : "John"},
   {"id" : 2, "name" : "Mary"}
]

我如何设置@apiSuccess？

我曾尝试过Object []，但不知道如何设置字段名称。 感谢。

Answer 1

让我们在上面的示例中说id和name是用户配置文件，并且你有一个用户配置文件对象数组，然后@apiSuccess看起来像：

/**
 * @api {get} /users
 * @apiSuccess {Object[]} profiles       List of user profiles.
 * @apiSuccess {Number}   profiles.Id    Users id.
 * @apiSuccess {String}   profiles.Name  Users Name.
 */