org.springdoc.core.GroupedOpenApi Maven / Gradle / Ivy
The newest version!
/*
*
* *
* * *
* * * * Copyright 2019-2022 the original author or authors.
* * * *
* * * * Licensed 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
* * * *
* * * * https://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 org.springdoc.core;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Objects;
import org.apache.commons.lang3.StringUtils;
import org.springdoc.core.customizers.OpenApiCustomiser;
import org.springdoc.core.customizers.OperationCustomizer;
import org.springdoc.core.customizers.RouterOperationCustomizer;
import org.springdoc.core.filters.OpenApiMethodFilter;
import org.springframework.util.Assert;
import org.springframework.util.CollectionUtils;
import static org.springdoc.core.Constants.GROUP_NAME_NOT_NULL_OR_EMPTY;
/**
* The type Grouped open api.
* @author bnasslahsen
*/
public class GroupedOpenApi {
/**
* The Group.
*/
private final String group;
/**
* The Paths to match.
*/
private final List pathsToMatch;
/**
* The Packages to scan.
*/
private final List packagesToScan;
/**
* The Packages to exclude.
*/
private final List packagesToExclude;
/**
* The Paths to exclude.
*/
private final List pathsToExclude;
/**
* The Produces to match.
*/
private final List producesToMatch;
/**
* The Headers to match.
*/
private final List headersToMatch;
/**
* The Consumes to match.
*/
private final List consumesToMatch;
/**
* The Display name.
*/
private final String displayName;
/**
* The Open api customisers.
*/
private List openApiCustomisers;
/**
* The Operation customizers.
*/
private List operationCustomizers;
/**
* The Router Operation customizers.
*/
private List routerOperationCustomizers;
/**
* The method filters to use.
*/
private List openApiMethodFilters;
/**
* Instantiates a new Grouped open api.
*
* @param builder the builder
*/
private GroupedOpenApi(Builder builder) {
Assert.isTrue(StringUtils.isNotBlank(builder.group), GROUP_NAME_NOT_NULL_OR_EMPTY);
this.group =builder.group;
this.pathsToMatch = builder.pathsToMatch;
this.packagesToScan = builder.packagesToScan;
this.producesToMatch = builder.producesToMatch;
this.consumesToMatch = builder.consumesToMatch;
this.headersToMatch = builder.headersToMatch;
this.packagesToExclude = builder.packagesToExclude;
this.pathsToExclude = builder.pathsToExclude;
this.displayName = StringUtils.defaultIfEmpty(builder.displayName, this.group);
this.openApiCustomisers = Objects.requireNonNull(builder.openApiCustomisers);
this.operationCustomizers = Objects.requireNonNull(builder.operationCustomizers);
this.routerOperationCustomizers = Objects.requireNonNull(builder.routerOperationCustomizers);
this.openApiMethodFilters = Objects.requireNonNull(builder.methodFilters);
if (CollectionUtils.isEmpty(this.pathsToMatch)
&& CollectionUtils.isEmpty(this.packagesToScan)
&& CollectionUtils.isEmpty(this.producesToMatch)
&& CollectionUtils.isEmpty(this.consumesToMatch)
&& CollectionUtils.isEmpty(this.headersToMatch)
&& CollectionUtils.isEmpty(this.pathsToExclude)
&& CollectionUtils.isEmpty(this.packagesToExclude)
&& CollectionUtils.isEmpty(openApiCustomisers)
&& CollectionUtils.isEmpty(operationCustomizers)
&& CollectionUtils.isEmpty(openApiMethodFilters))
throw new IllegalStateException("Packages to scan or paths to filter or openApiCustomisers/operationCustomizers can not be all null for the group:" + this.group);
}
/**
* Builder builder.
*
* @return the builder
*/
public static Builder builder() {
return new Builder();
}
/**
* Gets produces to match.
*
* @return the produces to match
*/
public List getProducesToMatch() {
return producesToMatch;
}
/**
* Gets headers to match.
*
* @return the headers to match
*/
public List getHeadersToMatch() {
return headersToMatch;
}
/**
* Gets consumes to match.
*
* @return the consumes to match
*/
public List getConsumesToMatch() {
return consumesToMatch;
}
/**
* Gets group.
*
* @return the group
*/
public String getGroup() {
return group;
}
/**
* Gets paths to match.
*
* @return the paths to match
*/
public List getPathsToMatch() {
return pathsToMatch;
}
/**
* Gets packages to scan.
*
* @return the packages to scan
*/
public List getPackagesToScan() {
return packagesToScan;
}
/**
* Gets packages to exclude.
*
* @return the packages to exclude
*/
public List getPackagesToExclude() {
return packagesToExclude;
}
/**
* Gets paths to exclude.
*
* @return the paths to exclude
*/
public List getPathsToExclude() {
return pathsToExclude;
}
/**
* Gets open api customisers.
*
* @return the open api customisers
*/
public List getOpenApiCustomisers() {
return openApiCustomisers;
}
/**
* Gets operation customizers.
*
* @return the operation customizers
*/
public List getOperationCustomizers() {
return operationCustomizers;
}
/**
* Gets open api method filters.
*
* @return the open api method filters
*/
public List getOpenApiMethodFilters() {
return openApiMethodFilters;
}
/**
* Gets router operation customizers.
*
* @return the router operation customizers
*/
public List getRouterOperationCustomizers() {
return routerOperationCustomizers;
}
/**
* Gets display name.
*
* @return the display name
*/
public String getDisplayName() {
return displayName;
}
/**
* Add all open api customizer grouped open api.
*
* @param openApiCustomizerCollection the open api customizer collection
* @return the grouped open api
*/
public GroupedOpenApi addAllOpenApiCustomizer(Collection openApiCustomizerCollection) {
List result = new ArrayList<>();
result.addAll(openApiCustomizerCollection);
result.addAll(openApiCustomisers);
openApiCustomisers = result;
return this;
}
/**
* Add all operation customizer grouped open api.
*
* @param operationCustomizerCollection the operation customizer collection
* @return the grouped open api
*/
public GroupedOpenApi addAllOperationCustomizer(Collection operationCustomizerCollection) {
List result = new ArrayList<>();
result.addAll(operationCustomizerCollection);
result.addAll(operationCustomizers);
operationCustomizers = result;
return this;
}
/**
* Add all open api method filter grouped open api.
*
* @param openApiMethodFilterCollection the open api method filter collection
* @return the grouped open api
*/
public GroupedOpenApi addAllOpenApiMethodFilter(Collection openApiMethodFilterCollection) {
List result = new ArrayList<>();
result.addAll(openApiMethodFilterCollection);
result.addAll(openApiMethodFilters);
openApiMethodFilters = result;
return this;
}
/**
* The type Builder.
* @author bnasslahsen
*/
public static class Builder {
/**
* The Open api customisers.
*/
private final List openApiCustomisers = new ArrayList<>();
/**
* The Operation customizers.
*/
private final List operationCustomizers = new ArrayList<>();
/**
* The Router Operation customizers.
*/
private final List routerOperationCustomizers = new ArrayList<>();
/**
* The methods filters to apply.
*/
private final List methodFilters = new ArrayList<>();
/**
* The Group.
*/
private String group;
/**
* The Paths to match.
*/
private List pathsToMatch;
/**
* The Packages to scan.
*/
private List packagesToScan;
/**
* The Packages to exclude.
*/
private List packagesToExclude;
/**
* The Paths to exclude.
*/
private List pathsToExclude;
/**
* The Produces to match.
*/
private List producesToMatch;
/**
* The Headers to match.
*/
private List headersToMatch;
/**
* The Consumes to match.
*/
private List consumesToMatch;
/**
* The Display name.
*/
private String displayName;
/**
* Instantiates a new Builder.
*/
private Builder() {
// use static factory method in parent class
}
/**
* Group builder.
*
* @param group the group
* @return the builder
*/
public Builder group(String group) {
this.group = group;
return this;
}
/**
* Paths to match builder.
*
* @param pathsToMatch the paths to match
* @return the builder
*/
public Builder pathsToMatch(String... pathsToMatch) {
this.pathsToMatch = Arrays.asList(pathsToMatch);
return this;
}
/**
* Packages to scan builder.
*
* @param packagesToScan the packages to scan
* @return the builder
*/
public Builder packagesToScan(String... packagesToScan) {
this.packagesToScan = Arrays.asList(packagesToScan);
return this;
}
/**
* Produces to match builder.
*
* @param producesToMatch the produces to match
* @return the builder
*/
public Builder producesToMatch(String... producesToMatch) {
this.producesToMatch = Arrays.asList(producesToMatch);
return this;
}
/**
* Consumes to match builder.
*
* @param consumesToMatch the consumes to match
* @return the builder
*/
public Builder consumesToMatch(String... consumesToMatch) {
this.consumesToMatch = Arrays.asList(consumesToMatch);
return this;
}
/**
* Headers to match builder.
*
* @param headersToMatch the headers to match
* @return the builder
*/
public Builder headersToMatch(String... headersToMatch) {
this.headersToMatch = Arrays.asList(headersToMatch);
return this;
}
/**
* Paths to exclude builder.
*
* @param pathsToExclude the paths to exclude
* @return the builder
*/
public Builder pathsToExclude(String... pathsToExclude) {
this.pathsToExclude = Arrays.asList(pathsToExclude);
return this;
}
/**
* Packages to exclude builder.
*
* @param packagesToExclude the packages to exclude
* @return the builder
*/
public Builder packagesToExclude(String... packagesToExclude) {
this.packagesToExclude = Arrays.asList(packagesToExclude);
return this;
}
/**
* Add open api customiser builder.
*
* @param openApiCustomiser the open api customiser
* @return the builder
*/
public Builder addOpenApiCustomiser(OpenApiCustomiser openApiCustomiser) {
this.openApiCustomisers.add(openApiCustomiser);
return this;
}
/**
* Add operation customizer builder.
*
* @param operationCustomizer the operation customizer
* @return the builder
*/
public Builder addOperationCustomizer(OperationCustomizer operationCustomizer) {
this.operationCustomizers.add(operationCustomizer);
return this;
}
/**
* Add router operation customizer builder
*
* @param routerOperationCustomizer the router operation customizer
* @return the builder
*/
public Builder addRouterOperationCustomizer(RouterOperationCustomizer routerOperationCustomizer) {
this.routerOperationCustomizers.add(routerOperationCustomizer);
return this;
}
/**
* Add method filter.
*
* @param methodFilter an additional filter to apply to the matched methods
* @return the builder
*/
public Builder addOpenApiMethodFilter(OpenApiMethodFilter methodFilter) {
this.methodFilters.add(methodFilter);
return this;
}
/**
* Display name builder.
*
* @param displayName the display name
* @return the builder
*/
public Builder displayName(String displayName) {
this.displayName = displayName;
return this;
}
/**
* Build grouped open api.
*
* @return the grouped open api
*/
public GroupedOpenApi build() {
return new GroupedOpenApi(this);
}
}
}