Skip to content

fix swagger schema forcing for enums #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
SirCotare merged 2 commits into from
Oct 9, 2025
Merged

fix swagger schema forcing for enums #37

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e0a2129
add utility methods to read scanned packages of classScanner instances
SirCotare Oct 9, 2025
db94a1c
add ability to force enums in swagger
SirCotare Oct 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions src/main/java/it/aboutbits/springboot/toolbox/reflection/util/ClassScannerUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,20 @@ public static ClassScanner getScannerForPackages(String... packages) {

public static final class ClassScanner implements AutoCloseable {
private final ScanResult scanResult;
private final String[] packages;

private ClassScanner(String... packages) {
this.packages = packages;
this.scanResult = new ClassGraph()
.enableAllInfo()
.acceptPackages(packages)
.scan();
}

public String[] getScannedPackages() {
return packages;
}

@SuppressWarnings("unchecked")
public <T> Set<Class<? extends T>> getSubTypesOf(@NonNull Class<T> clazz) {
return scanResult.getClassesImplementing(clazz).loadClasses()
Expand Down
29 changes: 29 additions & 0 deletions ...boutbits/springboot/toolbox/swagger/customization/force_schema/ForceSchemaCustomizer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,18 @@
import io.swagger.v3.core.jackson.ModelResolver;
import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.OpenAPI;
import io.swagger.v3.oas.models.media.Schema;
import it.aboutbits.springboot.toolbox.reflection.util.ClassScannerUtil;
import it.aboutbits.springboot.toolbox.swagger.annotation.ForceSwaggerSchema;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springdoc.core.customizers.OpenApiCustomizer;

import java.util.Arrays;
import java.util.LinkedHashMap;

@RequiredArgsConstructor
@Slf4j
public class ForceSchemaCustomizer implements OpenApiCustomizer {
private final ModelResolver modelResolver;
private final ClassScannerUtil.ClassScanner classScanner;
Expand All @@ -37,6 +41,26 @@ private void addAnnotatedSchemas(OpenAPI openAPI) {
var annotatedClasses = classScanner.getClassesAnnotatedWith(ForceSwaggerSchema.class);

for (var clazz : annotatedClasses) {
log.info("Forcing schema for class: {}", clazz.getName());

if (clazz.isEnum()) {
var fqn = clazz.getName();
if (!openAPI.getComponents().getSchemas().containsKey(fqn)) {
var schema = new Schema<String>();
schema.name(fqn);
schema.setEnum(
Arrays.stream(clazz.getEnumConstants())
.map(Object::toString)
.toList()
);
schema.setType("string");
schema.addType("string");

openAPI.getComponents().getSchemas().put(fqn, schema);
}
continue;
}

var schemas = customModelConverters.read(clazz);
// Only add if not already present (to avoid overriding naturally discovered schemas)
schemas.forEach((key, schema) -> {
Expand All @@ -45,6 +69,11 @@ private void addAnnotatedSchemas(OpenAPI openAPI) {
}
});
}

if (annotatedClasses.isEmpty()) {
log.info("No classes with @ForceSwaggerSchema annotation found!");
log.debug("Scanned packages: {}", String.join(", ", classScanner.getScannedPackages()));
}
}
}