/*
 * Copyright (c) 2022-present Charles7c Authors. All Rights Reserved.
 * <p>
 * Licensed under the GNU LESSER GENERAL PUBLIC LICENSE 3.0;
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * <p>
 * http://www.gnu.org/licenses/lgpl.html
 * <p>
 * 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 top.continew.starter.apidoc.util;

import org.springdoc.core.models.GroupedOpenApi;

/**
 * 接口文档工具类
 *
 * @author echo
 * @author Charles7c
 * @since 2.5.2
 */
public class ApiDocUtils {

    private ApiDocUtils() {
    }

    /**
     * 构建分组接口文档
     *
     * @param group        分组名称
     * @param pathsToMatch 路径匹配
     * @return GroupedOpenApi
     * @since 2.13.0
     */
    public static GroupedOpenApi buildGroupedOpenApi(String group, String... pathsToMatch) {
        return buildGroupedOpenApi(group, group, pathsToMatch);
    }

    /**
     * 构建分组接口文档
     *
     * @param group        分组名称
     * @param displayName  分组显示名称
     * @param pathsToMatch 路径匹配
     * @return GroupedOpenApi
     * @since 2.13.0
     */
    public static GroupedOpenApi buildGroupedOpenApi(String group, String displayName, String... pathsToMatch) {
        return GroupedOpenApi.builder().group(group).displayName(displayName).pathsToMatch(pathsToMatch).build();
    }
}