3.Swagger-UI

Swagger-UI

Swagger-UI是HTML, Javascript, CSS的一个集合，可以动态地根据注解生成在线API文档。

常用注解

● @Api：用于修饰Controller类，生成Controller相关文档信息 @Controller @Api(tags =
“OmsOrderDaoController”, description = “订单相关”) public class
OmsOrderDaoController {

● @ApiOperation：用于修饰Controller类中的方法，生成接口方法相关文档信息
@RequestMapping(value = “/findOrderById”,method = RequestMethod.POST)
@ApiOperation(value = “查找订单”) @ResponseBody public
CommonResult findOrderById(@RequestParam(“id”) Long id){

● @ApiParam：用于修饰接口中的参数，生成接口参数相关文档信息 public CommonResult
add(@RequestParam(“id”)@ApiParam(“参数id”) Long id){

● @ApiModelProperty：用于修饰实体类的属性，当实体类是请求参数或返回结果时，直接生成相关文档信息
@ApiModelProperty(value = “订单id”) private Long id;