com.ly.doc.model.ApiReqParam Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of smart-doc Show documentation
Smart-doc is a tool that supports both JAVA RESTFUL API and Apache Dubbo RPC interface document generation.
There is a newer version: 3.0.5
/*
 * Copyright (C) 2018-2023 smart-doc
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package com.ly.doc.model;

import java.util.Objects;

import com.ly.doc.constants.ApiReqParamInTypeEnum;

import org.apache.commons.lang3.StringUtils;

/**
 * Description:
 * http request param info model
 *
 * @author yu 2018/06/18.
 * @author chenqi  2021/07/15
 */
public class ApiReqParam {

    /**
     * Request param name
     */
    private String name;

    /**
     * Request param type
     */
    private String type;

    /**
     * request param defaultValue
     */
    private String value;

    /**
     * Request param description
     */
    private String desc;

    /**
     * where is param location
     * default header
     *
     * @see ApiReqParamInTypeEnum value
     */
    private String paramIn;

    /**
     * required flag
     *
     * @since 1.7.0
     */
    private boolean required;

    /**
     * Starting version number
     *
     * @since 1.7.0
     */
    private String since = "-";

    /**
     * @since 2.2.2
     * Regular expression match request param
     */
    private String pathPatterns;

    /**
     * @since 2.2.2
     * Regular expression ignore request param
     */
    private String excludePathPatterns;

    public static ApiReqParam builder() {
        return new ApiReqParam();
    }

    public static ApiParam convertToApiParam(ApiReqParam param) {
        return ApiParam.of().setField(param.getName()).setValue(param.getValue())
            .setRequired(param.isRequired()).setDesc(param.getDesc()).setConfigParam(true)
            .setVersion("-").setType(param.getType());
    }

    public String getName() {
        return name;
    }

    public ApiReqParam setName(String name) {
        this.name = name;
        return this;
    }

    public String getType() {
        return type;
    }

    public ApiReqParam setType(String type) {
        this.type = type;
        return this;
    }

    public String getDesc() {
        return desc;
    }

    public ApiReqParam setDesc(String desc) {
        this.desc = desc;
        return this;
    }

    public boolean isRequired() {
        return required;
    }

    public ApiReqParam setRequired(boolean required) {
        this.required = required;
        return this;
    }

    public String getSince() {
        return since;
    }

    public ApiReqParam setSince(String since) {
        this.since = since;
        return this;
    }

    public String getValue() {
        return value;
    }

    public ApiReqParam setValue(String value) {
        this.value = value;
        return this;
    }

    public String getPathPatterns() {
        return pathPatterns;
    }

    public ApiReqParam setPathPatterns(String pathPatterns) {
        this.pathPatterns = pathPatterns;
        return this;
    }

    public String getExcludePathPatterns() {
        return excludePathPatterns;
    }

    public ApiReqParam setExcludePathPatterns(String excludePathPatterns) {
        this.excludePathPatterns = excludePathPatterns;
        return this;
    }

    public String getParamIn() {
        if (StringUtils.isEmpty(paramIn)) {
            return ApiReqParamInTypeEnum.HEADER.getValue();
        }
        return paramIn;
    }

    public ApiReqParam setParamIn(String paramIn) {
        this.paramIn = paramIn;
        return this;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        ApiReqParam that = (ApiReqParam) o;
        return Objects.equals(name, that.name);
    }

    @Override
    public int hashCode() {
        return Objects.hash(name);
    }

    @Override
    public String toString() {
        final StringBuilder sb = new StringBuilder("{");
        sb.append("\"name\":\"")
            .append(name).append('\"');
        sb.append(",\"type\":\"")
            .append(type).append('\"');
        sb.append(",\"value\":\"")
            .append(value).append('\"');
        sb.append(",\"desc\":\"")
            .append(desc).append('\"');
        sb.append(",\"paramIn\":")
            .append(paramIn);
        sb.append(",\"required\":")
            .append(required);
        sb.append(",\"since\":\"")
            .append(since).append('\"');
        sb.append(",\"pathPatterns\":\"")
            .append(pathPatterns).append('\"');
        sb.append(",\"excludePathPatterns\":\"")
            .append(excludePathPatterns).append('\"');
        sb.append('}');
        return sb.toString();
    }
}