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

Question

我尝试用apidoc生成一个API文档。

如果我的响应是像这样的数组

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

如何在@apiSuccess中设置？

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

Answer 1

假设在上面的示例中，id和名称属于用户配置文件，并且您有一个用户配置文件对象数组，那么@apiSuccess将如下所示：

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