注解@ApiOperation

一、样式

 * Description:查询客户订单信息 <br>
 *  * @author li.xueru<br>
 * @param request <br>
 * @return String <br>
 * @throws BaseAppException <br>
 */
@ApiOperation(value = "查询客户订单信息")
@RequestMapping(value = "/custOrderInfo", method = RequestMethod.GET)
public String queryCustOrderInfo(
    @ApiParam(value = "查询客户订单信息请求信息") @ModelAttribute QueryCustOrderInfoReq request) throws BaseAppException {
    return orderDetailService.queryCustOrderInfo(request.getPartyType(), request.getPartyCode());
}

二、说明

1、@ApiOperation不是spring自带的注解是swagger里的com.wordnik.swagger.annotations.ApiOperation;
2、@ApiOperation和@ApiParam为添加的API相关注解，个参数说明如下：

• @ApiOperation(value = “接口说明”, httpMethod = “接口请求方式”, response = “接口返回参数类型”, notes = “接口发布说明”）；其他参数可参考源码；
• @ApiParam(required = “是否必须参数”, name = “参数名称”, value = “参数具体描述”）。

三、注意

• 实际项目中非常需要写文档，提高Java服务端和Web前端以及移动端的对接效率。
• Swagger是当前最好用的Restful API文档生成的开源项目，通过swagger-spring项目
• 实现了与SpingMVC框架的无缝集成功能，方便生成spring restful风格的接口文档，
• 同时swagger-ui还可以测试spring restful风格的接口功能。
  四、原文参考
  http://blog.csdn.net/fansunion/article/details/51923720
  https://blog.csdn.net/luzijun1992/article/details/79918474
  五、更多
  https://www.cnblogs.com/xinglongbing521/p/10258818.html