2

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に追加するにはどうすればよいですか?

Swagger ドキュメントの例

4

2 に答える 2