如何在Swagger中添加更多關於API的信息？

我在我的項目中包含了swagger-springmvc，並設法讓Swagger UI正常工作，但現在關於UI中API的信息非常少。我看到的只是通過反思提取的信息。如何在Swagger中添加更多關於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 = "https://stackoverflow.com/users/{filter}", method = RequestMethod.GET) 
public 
@ResponseBody 
Collection<User> getUsers(@PathVariable("filter") String filter) throws Exception { 
    return domain.getUsersFilteredBy(filter); 
}

而且每一種方法揚鞭的右側記載的方法的名稱，在這種情況下：

get Users

，但我期待看到這個：

Read all users matching given filter

在helloreverb.com的例子中，我看到每個t軟管方法。我怎麼能大招把我的控制器方法的描述添加到用戶界面呢？

Swagger documentation example

來源

2014-05-16 stackular

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

來源

2014-05-16 17:39:17

如何在Swagger中添加更多關於API的信息？

回答

相關問題