com.ly.doc.model.request.ApiRequestExample 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.request;

import java.util.List;

import com.ly.doc.model.FormData;
import com.power.common.util.StringUtil;

import org.apache.commons.lang3.StringUtils;

/**
 * @author yu 2019/12/22.
 */

public class ApiRequestExample {

    /**
     * json body
     */
    private String jsonBody;

    /**
     * example body
     */
    private String exampleBody;

    /**
     * url
     */
    private String url;

    /**
     * list of form data
     */
    private List formDataList;

    private boolean json;

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

    public String getJsonBody() {
        return jsonBody;
    }

    public ApiRequestExample setJsonBody(String jsonBody) {
        this.jsonBody = jsonBody;
        return this;
    }

    public ApiRequestExample addJsonBody(String jsonBody) {
        if (StringUtil.isNotEmpty(jsonBody)) {
            this.jsonBody = StringUtils.joinWith("&", this.jsonBody, jsonBody);
        } else {
            this.jsonBody = jsonBody;
        }
        return this;
    }

    public String getUrl() {
        return url;
    }

    public ApiRequestExample setUrl(String url) {
        this.url = url;
        return this;
    }

    public List getFormDataList() {
        return formDataList;
    }

    public ApiRequestExample setFormDataList(List formDataList) {
        this.formDataList = formDataList;
        return this;
    }

    public boolean isJson() {
        return json;
    }

    public ApiRequestExample setJson(boolean json) {
        this.json = json;
        return this;
    }

    public String getExampleBody() {
        return exampleBody;
    }

    public ApiRequestExample setExampleBody(String exampleBody) {
        this.exampleBody = exampleBody;
        return this;
    }
}