【SWAGGER2】swagger2 隐藏model,添加文字说明 ,swagger 2.9.2

添加maven pom依赖

		<dependency>
			<groupId>io.springfox</groupId>
			<artifactId>springfox-swagger2</artifactId>
			<version>2.9.2</version>
		</dependency>

两个重要注解 @ApiModel,@ApiModelProperty

@ApiModel 用在class类上,对类解释,如:  @ApiModel(value = "订单")

@ApiModelProperty 顾名思义指的是model的属性,用在属性上,如:@ApiModelProperty(value = "订单号id(不需要传)",readOnly = true),

其中@ApiModelProperty 中的标签readOnly(表示是否只读 若为true,则是不会显示在swagger-ui的实体上,默认false),required(表示是否必传,若为true表示必传,默认为false)

eg:

package xx.xx.xx.xx.entity;

import io.swagger.annotations.ApiModel;
import io.swagger.annotations.ApiModelProperty;



import java.io.Serializable;
import java.text.SimpleDateFormat;
import java.util.Date;

/**
*  
* @author zsigner
*/
@ApiModel(value = "订单")
public class RepairsOrder implements Serializable {

    private static final long serialVersionUID = -2729271700842553073L;
    /**
    * 订单号id
    */
    @ApiModelProperty(value = "订单号id(不需要传)",readOnly = true)
    private Integer orderId;

    /**
    * 订单号
    */
    @ApiModelProperty(value = "订单编号号(不需要传)",readOnly = true)
    private Long orderNumber;

    
    /**
    * 品牌id
    */
    @ApiModelProperty(value = "品牌id",required = true)
    private Integer brandId;

    


    public RepairsOrder() {
    }

    public Integer getOrderId() {
        return orderId;
    }

    public void setOrderId(Integer orderId) {
        this.orderId = orderId;
    }

    public Long getOrderNumber() {
        return orderNumber == null ? System.currentTimeMillis() : orderNumber;
    }

    public void setOrderNumber(Long orderNumber) {
        this.orderNumber = orderNumber;
    }


    public Integer getBrandId() {
        return brandId;
    }

    public void setBrandId(Integer brandId) {
        this.brandId = brandId;
    }

}

Controller:

@ApiOperation(value = "提交订单接口", notes = "提交订单接口")
    @RequestMapping(value = "add",method = RequestMethod.POST)
    public void add(@RequestBody RepairsOrder repairsOrder){

        .....;
    }

结果如图:

 

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

Zsigner

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值