-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
DefaultModelProvider.java
193 lines (177 loc) · 6.48 KB
/
DefaultModelProvider.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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
/*
*
* Copyright 2015-2019 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
*
* 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 springfox.documentation.schema;
import com.fasterxml.classmate.ResolvedType;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Component;
import springfox.documentation.schema.plugins.SchemaPluginsManager;
import springfox.documentation.schema.property.ModelPropertiesProvider;
import springfox.documentation.spi.schema.EnumTypeDeterminer;
import springfox.documentation.spi.schema.contexts.ModelContext;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.TreeMap;
import static java.util.Optional.*;
import static java.util.function.Function.*;
import static java.util.stream.Collectors.*;
import static springfox.documentation.schema.Collections.*;
import static springfox.documentation.schema.Maps.*;
import static springfox.documentation.schema.ResolvedTypes.*;
/**
* Use an implementation of {@link ModelSpecificationProvider} instead
*
* @deprecated @since 3.0.0
*/
@Component
@Qualifier("default")
@Deprecated
public class DefaultModelProvider implements ModelProvider {
private static final Logger LOG = LoggerFactory.getLogger(DefaultModelProvider.class);
private final ModelPropertiesProvider propertiesProvider;
private final ModelDependencyProvider dependencyProvider;
private final SchemaPluginsManager schemaPluginsManager;
private final TypeNameExtractor typeNameExtractor;
private final EnumTypeDeterminer enumTypeDeterminer;
@Autowired
public DefaultModelProvider(
@Qualifier("cachedModelProperties") ModelPropertiesProvider propertiesProvider,
@Qualifier("cachedModelDependencies") ModelDependencyProvider dependencyProvider,
SchemaPluginsManager schemaPluginsManager,
TypeNameExtractor typeNameExtractor,
EnumTypeDeterminer enumTypeDeterminer) {
this.propertiesProvider = propertiesProvider;
this.dependencyProvider = dependencyProvider;
this.schemaPluginsManager = schemaPluginsManager;
this.typeNameExtractor = typeNameExtractor;
this.enumTypeDeterminer = enumTypeDeterminer;
}
@Override
public Optional<Model> modelFor(ModelContext modelContext) {
ResolvedType propertiesHost = modelContext.alternateEvaluatedType();
if (isContainerType(propertiesHost)
|| isMapType(propertiesHost)
|| enumTypeDeterminer.isEnum(propertiesHost.getErasedType())
|| springfox.documentation.schema.Types.isBaseType(propertiesHost)
|| modelContext.hasSeenBefore(propertiesHost)) {
LOG.debug(
"Skipping model of type {} as its either a container type, map, enum or base type, or its already "
+ "been handled",
resolvedTypeSignature(propertiesHost).orElse("<null>"));
return empty();
}
Optional<Model> syntheticModel = schemaPluginsManager.syntheticModel(modelContext);
if (syntheticModel.isPresent()) {
return of(schemaPluginsManager.model(modelContext));
}
return reflectionBasedModel(
modelContext,
propertiesHost);
}
private Optional<Model> reflectionBasedModel(
ModelContext modelContext,
ResolvedType propertiesHost) {
Map<String, ModelProperty> propertiesIndex
= properties(
modelContext,
propertiesHost).stream()
.collect(toMap(
ModelProperty::getName,
identity()));
LOG.debug("Inferred {} properties. Properties found {}",
propertiesIndex.size(),
String.join(
", ",
propertiesIndex.keySet()));
return of(modelBuilder(propertiesHost,
new TreeMap<>(propertiesIndex),
modelContext));
}
private Model modelBuilder(
ResolvedType propertiesHost,
Map<String, ModelProperty> properties,
ModelContext modelContext) {
String typeName = typeNameExtractor.typeName(ModelContext.fromParent(
modelContext,
propertiesHost));
modelContext.getBuilder()
.type(propertiesHost)
.name(typeName)
.qualifiedType(simpleQualifiedTypeName(propertiesHost))
.properties(properties)
.description("")
.baseModel("")
.discriminator("")
.subTypes(new ArrayList<>());
return schemaPluginsManager.model(modelContext);
}
@Override
public Map<ResolvedType, Model> dependencies(ModelContext modelContext) {
Map<ResolvedType, Model> models = new HashMap<>();
for (ResolvedType resolvedType : dependencyProvider.dependentModels(modelContext)) {
ModelContext parentContext = ModelContext.fromParent(
modelContext,
resolvedType);
Optional<Model> model = modelFor(parentContext);
if (model.isPresent()) {
models.put(
resolvedType,
model.get());
} else {
model = mapModel(
parentContext,
resolvedType);
model.ifPresent(m -> models.put(
resolvedType,
m));
}
}
return models;
}
private Optional<Model> mapModel(
ModelContext parentContext,
ResolvedType resolvedType) {
if (isMapType(resolvedType) && !parentContext.hasSeenBefore(resolvedType)) {
String typeName = typeNameExtractor.typeName(parentContext);
return Optional.of(parentContext.getBuilder()
.type(resolvedType)
.name(typeName)
.qualifiedType(simpleQualifiedTypeName(resolvedType))
.properties(new HashMap<>())
.description("")
.baseModel("")
.discriminator("")
.subTypes(new ArrayList<>())
.build());
}
return empty();
}
private List<ModelProperty> properties(
ModelContext context,
ResolvedType propertiesHost) {
return propertiesProvider.propertiesFor(
propertiesHost,
context);
}
}