swagger annotation

一、基于类的注解

    @Api(tags={"用户操作接口"})
        1.tags：对controller的描述。数组类型，可填写多个值，即生成多个相同的列表，只是描述有区别；


二、基于方法的注解

    @ApiOperation(value="根据订单信息获取下户专员信息", notes="根据订单的Id获取下户专员的详细信息", httpMethod = "POST")
        1.value：对action的简述；
        2.notes：对action的详细描述；
        3.httpMethod：action的调用方式（可填写 "GET"/"POST"/"DELETE"/"PUT"）；
            注：建议必填，如果不填写，会生成全部调用方式的action条目。

    @ApiParam(name = "username", value = "下户专员姓名", required = true)
        1.name：参数名字；
            注：建议校对，如果输入错误，不会自动判重。
        2.value：参数的描述；
        3.required：是否是必传参数。布尔值类型。
            注：如果填写“true”，在页面调用api会提示必填。
        注意：此注解后要跟一个 @RequestParam() 注解，不然在swagger ui中参数类型不会被定义为 query ，测试调用的时候，会拿不到传参值。

    @ApiIgnore()
        注：action加此注解，就不会显示在swagger的页面上。



三、基于实体的注解（如果接口返回或者传参是一个实体，那么下面的两个注解会有用）

    @ApiModel(value="银行信息",description="记录银行详细信息")

    @ApiModelProperty(value="卡号",name="cardNo",required=true)