如何在Swagger中添加有关API的更多信息？

Question

我在项目中包含swagger-springmvc并设法使Swagger UI正常工作，但是现在关于UI中的API的信息非常少。我所看到的只是通过反思提取的信息。

这就是控制器方法的样子：

/**
 * Read all users matching given filter
 * @param String filter The text by which to filter the usernames
 * @return User[] Array of users matching given filter
 * @throws Exception
 */
@RequestMapping(value = "/users/{filter}", method = RequestMethod.GET)
public
@ResponseBody
Collection<User> getUsers(@PathVariable("filter") String filter) throws Exception {
    return domain.getUsersFilteredBy(filter);
}

在每个方法的右侧，Swagger记录方法的名称，在这种情况下：

get Users

但我期待看到这个：

Read all users matching given filter

在helloreverb.com上的示例中，我看到了每种方法的描述。我怎么能大摇大摆地将控制器方法的描述添加到UI中呢？

Answer 1

@ApiOperation(value = "Read all users matching given filter",  notes = "Will get all the users for the given filter")