com.feingto.cloud.dto.apis.ParameterDTO Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of feingto-common Show documentation

There is a newer version: 2.3.5.RELEASE

package com.feingto.cloud.dto.apis;

import com.feingto.cloud.domain.enums.ParamPosition;
import com.feingto.cloud.domain.enums.ParamType;
import lombok.Data;
import lombok.experimental.Accessors;

import java.io.Serializable;
import java.util.ArrayList;
import java.util.List;

/**
 * 参数定义
 *
 * @author longfei
 */
@Data
@Accessors(chain = true)
public class ParameterDTO implements Serializable {
    private static final long serialVersionUID = -4173974187581227951L;

    private String name;

    /**
     * 是否必填
     */
    private boolean required = false;

    private ParamPosition position;

    private ParamType type;

    /**
     * 是否系统内置
     */
    private boolean system = false;

    /**
     * 系统内置参数默认值
     */
    private String defaultValue;

    /**
     * 正则表达式规则
     */
    private String regexRule;

    private String description;

    /**
     * 对应入参名称
     */
    private String referenceName;

    /**
     * 对应入参位置
     */
    private ParamPosition referencePosition;

    /**
     * Mock规则
     */
    private String mockRule;

    /**
     * 文档可见
     */
    private boolean docVisible = true;

    /**
     * 文档中顺序
     */
    private Integer docOrder = 1;

    private List children = new ArrayList<>();
}