/
SchemaCustomizer.java
68 lines (63 loc) · 2.63 KB
/
SchemaCustomizer.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/*-
* #%L
* OpenAPI Generator for Spring Boot :: API
* %%
* Copyright (C) 2020 QAware GmbH
* %%
* 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
*
* 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.
* #L%
*/
package de.qaware.openapigeneratorforspring.common.schema.customizer;
import com.fasterxml.jackson.databind.JavaType;
import de.qaware.openapigeneratorforspring.common.annotation.AnnotationsSupplier;
import de.qaware.openapigeneratorforspring.common.schema.resolver.SchemaResolver;
import de.qaware.openapigeneratorforspring.common.util.OpenApiOrderedUtils;
import de.qaware.openapigeneratorforspring.model.media.Schema;
import java.util.function.Consumer;
/**
* Customizer for {@link Schema}. Run AFTER the initial schema is built
* and annotations are applied, but BEFORE nested properties are resolved.
*
* @see SchemaPropertiesCustomizer for customizing properties
*/
@FunctionalInterface
public interface SchemaCustomizer extends OpenApiOrderedUtils.DefaultOrdered {
/**
* Customize the given schema by reference.
*
* @param schema schema
* @param javaType java type this schema was built from (might be Void)
* @param annotationsSupplier annotations supplier used during schema building
* @param recursiveResolver recursive resolver
*/
void customize(Schema schema, JavaType javaType, AnnotationsSupplier annotationsSupplier, RecursiveResolver recursiveResolver);
/**
* Recursive resolver for {@link #customize} call. Similar
* to {@link SchemaResolver} but with less flexibility: only
* class types can be analyzed, they are always referenced
* and the {@link SchemaResolver.Mode mode} is fixed.
*
* <p> When used inside a customizer, be careful to prevent
* endless recursion by only applying the customization
* on a condition, such as a annotation being present.
*
* @see SchemaResolver#resolveFromClassWithoutReference
*/
interface RecursiveResolver {
/**
* @param clazz class type to be resolved
* @param setter setter to apply the schema reference
*/
void alwaysAsReference(Class<?> clazz, Consumer<Schema> setter);
}
}