我想为现有的一组RESTful API构建Swagger文档.我有以下要求:
>离线生成Swagger Doc(我使用了http://kongchen.github.io/swagger-maven-plugin/).这个插件帮助我在编译期间生成Swagger文档.
>阅读现有的Javadoc,以便可以在Swagger文档中使用它们.
到目前为止使用上面的插件我能够实现第1点.所以对于现有的REST方法:
/**
*
* Gets the {@link DisplayPreferenceModel} with the name as provided in the parameter. The preference with the given name defined at the tenant or master level is returned.
* This API gives us the preference if it is eligible for unauthorized access If it is not eligible it throws an Exception saying Authorization required.
*
* @param preferenceName
* - The name of the preference.
* @return {@link DisplayPreferenceModel}
*/
@RequestMapping(method = RequestMethod.GET, value = "/preferences/{preferenceName}")
@ApiOperation(value = "This API gives us the preference if it is eligible for unauthorized access If it is not eligible it throws an Exception saying Authorization required",
notes = "No Notes please", response = DisplayPreferenceModel.class)
@ApiResponses(value = {
@ApiResponse(code = 400, message = "Invalid preferenceName supplied"),
@ApiResponse(code = 404, message = "Display Preference Not Found")
}
)
public DisplayPreferenceModel getDisplayPreference( @PathVariable("preferenceName") final String preferenceName ) {
}
我能够生成Swagger文档. @ApiOperation&的用法@ApiResponses使我的文档看起来很棒.
但是,我的问题是我可以使用Javadoc而不是让每个开发人员创建@ApiOperation& @ApiResponses以便为我的团队节省时间?