swagger 注解

注解

contoller

• @Api：用在类上，说明该类的作用。

@Api(value = "文章对象接口")

• @ApiOperation：注解来给API增加方法说明。

@ApiOperation(value = "获取所有文章信息", notes = "获取所有文章对象的接口")

• @ApiParam 用来注解来给方法入参增加说明。

 @ApiParam(required = true, name="id", value = "文章id")

entity

• @ApiModel：描述一个Model的信息（一般用在请求参数无法使用@ApiImplicitParam注解进行描述的时候）
• @ApiModelProperty：描述一个model的属性

@ApiModel(value="TbArticle对象", description="文章")
public class TbArticle implements Serializable {
	private static final long serialVersionUID = 1L;
 	
 	@ApiModelProperty(value = "专栏ID")
    private String columnid;
}