Skip to content

Commit baa8627

Browse files
sam0r040timonback
sam0r040
and
timonback
authored
Feat/handle no payload (#687)
* feat(core): handle no payload methods Co-authored-by: David Müller <david.mueller@codecentric.de> fix(core): extract AsyncMessage#description Co-authored-by: David Müller <david.mueller@codecentric.de> feat(core): use fqn in for schema name Co-authored-by: David Müller <david.mueller@codecentric.de> refactor(core): split test for PayloadClassExtractor and TypeToClassConverter Co-authored-by: Timon Back <timonback@users.noreply.github.com> test(kafka): remove unused use-fqn setting Co-authored-by: David Müller <david.mueller@codecentric.de> test(kafka): update asyncapi.json Co-authored-by: David Müller <david.mueller@codecentric.de> refactor(core): extract TypeToClassConverter Co-authored-by: David Müller <david.mueller@codecentric.de> refactor(core): replace pair of resolved schema name and schema object with a specific record Co-authored-by: Timon Back <timonback@users.noreply.github.com> feat(core): add NoPayloadUsedConsumer Co-authored-by: David Müller <david.mueller@codecentric.de> refactor(core): update AsyncHeadersBuilder (wip) Co-authored-by: David Müller <david.mueller@codecentric.de> feat(core): Use new PayloadService (wip) Co-authored-by: David Müller <david.mueller@codecentric.de> refactor(core): Check description in Schema annotation in DefaultComponentsService test(core): Add PayloadServiceTest refactor(core): Give PayloadService a name feat(core): Add PayloadNotUsed Schema Co-authored-by: Timon Back <timonback@users.noreply.github.com> refactor(core): PayloadClassExtractor returns optional instead of throwing an exception Co-authored-by: Timon Back <timonback@users.noreply.github.com> diff --git a/springwolf-asyncapi/src/main/java/io/github/springwolf/asyncapi/v3/model/channel/message/MessagePayload.java b/springwolf-asyncapi/src/main/java/io/github/springwolf/asyncapi/v3/model/channel/message/MessagePayload.java index 9ccf6e1c..e6302005 100644 --- a/springwolf-asyncapi/src/main/java/io/github/springwolf/asyncapi/v3/model/channel/message/MessagePayload.java +++ b/springwolf-asyncapi/src/main/java/io/github/springwolf/asyncapi/v3/model/channel/message/MessagePayload.java @@ -7,10 +7,12 @@ import io.github.springwolf.asyncapi.v3.model.schema.MultiFormatSchema; import io.github.springwolf.asyncapi.v3.model.schema.SchemaObject; import lombok.EqualsAndHashCode; import lombok.Getter; +import lombok.ToString; @Getter @JsonSerialize(using = MessagePayloadSerializer.class) @EqualsAndHashCode +@ToString public class MessagePayload { private MultiFormatSchema multiFormatSchema; private SchemaObject schema; diff --git a/springwolf-asyncapi/src/main/java/io/github/springwolf/asyncapi/v3/model/channel/message/MessageReference.java b/springwolf-asyncapi/src/main/java/io/github/springwolf/asyncapi/v3/model/channel/message/MessageReference.java index b938b4d4..bc6b16b9 100644 --- a/springwolf-asyncapi/src/main/java/io/github/springwolf/asyncapi/v3/model/channel/message/MessageReference.java +++ b/springwolf-asyncapi/src/main/java/io/github/springwolf/asyncapi/v3/model/channel/message/MessageReference.java @@ -9,6 +9,7 @@ import lombok.NoArgsConstructor; import lombok.ToString; @EqualsAndHashCode +@ToString @NoArgsConstructor @AllArgsConstructor public class MessageReference implements Message, Reference { diff --git a/springwolf-asyncapi/src/main/java/io/github/springwolf/asyncapi/v3/model/schema/SchemaObject.java b/springwolf-asyncapi/src/main/java/io/github/springwolf/asyncapi/v3/model/schema/SchemaObject.java index 710a3ed0..497fb78e 100644 --- a/springwolf-asyncapi/src/main/java/io/github/springwolf/asyncapi/v3/model/schema/SchemaObject.java +++ b/springwolf-asyncapi/src/main/java/io/github/springwolf/asyncapi/v3/model/schema/SchemaObject.java @@ -10,6 +10,7 @@ import lombok.Builder; import lombok.Data; import lombok.EqualsAndHashCode; import lombok.NoArgsConstructor; +import lombok.ToString; import java.math.BigDecimal; import java.util.List; @@ -31,6 +32,7 @@ import java.util.Map; @NoArgsConstructor @AllArgsConstructor @EqualsAndHashCode(callSuper = true) +@ToString public class SchemaObject extends ExtendableObject implements Schema { /** * Adds support for polymorphism. The discriminator is the schema property name that is used to differentiate diff --git a/springwolf-asyncapi/src/main/java/io/github/springwolf/asyncapi/v3/model/schema/SchemaReference.java b/springwolf-asyncapi/src/main/java/io/github/springwolf/asyncapi/v3/model/schema/SchemaReference.java index 2384a153..848c27fb 100644 --- a/springwolf-asyncapi/src/main/java/io/github/springwolf/asyncapi/v3/model/schema/SchemaReference.java +++ b/springwolf-asyncapi/src/main/java/io/github/springwolf/asyncapi/v3/model/schema/SchemaReference.java @@ -9,6 +9,7 @@ import lombok.NoArgsConstructor; import lombok.ToString; @EqualsAndHashCode +@ToString @NoArgsConstructor @AllArgsConstructor public class SchemaReference implements Schema, Reference { diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/ComponentsService.java b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/ComponentsService.java index 9c982b3d..f5132257 100644 --- a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/ComponentsService.java +++ b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/ComponentsService.java @@ -12,6 +12,8 @@ public interface ComponentsService { Map<String, SchemaObject> getSchemas(); + SchemaObject resolveSchema(String schemaName); + String registerSchema(SchemaObject headers); String registerSchema(Class<?> type); diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/DefaultComponentsService.java b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/DefaultComponentsService.java index 59caf4e5..f2e3104c 100644 --- a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/DefaultComponentsService.java +++ b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/DefaultComponentsService.java @@ -14,6 +14,7 @@ import io.swagger.v3.core.jackson.TypeNameResolver; import io.swagger.v3.oas.models.media.ObjectSchema; import io.swagger.v3.oas.models.media.Schema; import io.swagger.v3.oas.models.media.StringSchema; +import jakarta.annotation.Nullable; import lombok.extern.slf4j.Slf4j; import org.apache.commons.lang3.StringUtils; @@ -60,6 +61,15 @@ public class DefaultComponentsService implements ComponentsService { .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue)); } + @Override + @Nullable + public SchemaObject resolveSchema(String schemaName) { + if (schemas.containsKey(schemaName)) { + return swaggerSchemaUtil.mapSchema(schemas.get(schemaName)); + } + return null; + } + @Override public String registerSchema(SchemaObject headers) { log.debug("Registering schema for {}", headers.getTitle()); @@ -81,6 +91,7 @@ public class DefaultComponentsService implements ComponentsService { @Override public String registerSchema(Class<?> type) { + // FIXME: Move this to the new HeadersService return this.registerSchema(type, properties.getDocket().getDefaultContentType()); } @@ -90,13 +101,13 @@ public class DefaultComponentsService implements ComponentsService { String actualContentType = StringUtils.isBlank(contentType) ? properties.getDocket().getDefaultContentType() : contentType; - Map<String, Schema> schemas = new LinkedHashMap<>(runWithFqnSetting((unused) -> converter.readAll(type))); + Map<String, Schema> newSchemas = new LinkedHashMap<>(runWithFqnSetting((unused) -> converter.readAll(type))); - String schemaName = getSchemaName(type, schemas); + String schemaName = getSchemaName(type, newSchemas); - preProcessSchemas(schemas, schemaName, type); - schemas.forEach(this.schemas::putIfAbsent); - schemas.values().forEach(schema -> postProcessSchema(schema, actualContentType)); + preProcessSchemas(newSchemas, schemaName, type); + newSchemas.forEach(this.schemas::putIfAbsent); + newSchemas.values().forEach(schema -> postProcessSchema(schema, actualContentType)); return schemaName; } @@ -130,11 +141,22 @@ public class DefaultComponentsService implements ComponentsService { return new ArrayList<>(resolvedPayloadModelName).get(0); } - return type.getSimpleName(); + return getNameFromClass(type); } private void preProcessSchemas(Map<String, Schema> schemas, String schemaName, Class<?> type) { processAsyncApiPayloadAnnotation(schemas, schemaName, type); + processSchemaAnnotation(schemas, schemaName, type); + } + + private void processSchemaAnnotation(Map<String, Schema> schemas, String schemaName, Class<?> type) { + Schema schemaForType = schemas.get(schemaName); + if (schemaForType != null) { + var schemaAnnotation = type.getAnnotation(io.swagger.v3.oas.annotations.media.Schema.class); + if (schemaAnnotation != null) { + schemaForType.setDescription(schemaAnnotation.description()); + } + } } private void processAsyncApiPayloadAnnotation(Map<String, Schema> schemas, String schemaName, Class<?> type) { @@ -161,9 +183,9 @@ public class DefaultComponentsService implements ComponentsService { } private String registerString() { - String schemaName = "String"; + String schemaName = getNameFromClass(String.class); StringSchema schema = new StringSchema(); - schema.setName(String.class.getName()); + schema.setName(schemaName); this.schemas.put(schemaName, schema); postProcessSchema(schema, DEFAULT_CONTENT_TYPE); @@ -181,6 +203,13 @@ public class DefaultComponentsService implements ComponentsService { return result; } + private String getNameFromClass(Class<?> type) { + if (properties.isUseFqn()) { + return type.getName(); + } + return type.getSimpleName(); + } + private void postProcessSchema(Schema schema, String contentType) { for (SchemasPostProcessor processor : schemaPostProcessors) { processor.process(schema, schemas, contentType); diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/headers/AsyncHeadersBuilder.java b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/headers/AsyncHeadersBuilder.java index 195fcb13..0496125f 100644 --- a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/headers/AsyncHeadersBuilder.java +++ b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/headers/AsyncHeadersBuilder.java @@ -2,7 +2,8 @@ package io.github.springwolf.core.asyncapi.components.headers; import io.github.springwolf.asyncapi.v3.model.schema.SchemaObject; +import io.github.springwolf.core.asyncapi.scanners.common.payload.NamedSchemaObject; public interface AsyncHeadersBuilder { - SchemaObject buildHeaders(Class<?> payloadType); + SchemaObject buildHeaders(NamedSchemaObject payloadSchema); } diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/headers/AsyncHeadersNotDocumented.java b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/headers/AsyncHeadersNotDocumented.java index b1548c4e..77b177bf 100644 --- a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/headers/AsyncHeadersNotDocumented.java +++ b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/headers/AsyncHeadersNotDocumented.java @@ -2,6 +2,7 @@ package io.github.springwolf.core.asyncapi.components.headers; import io.github.springwolf.asyncapi.v3.model.schema.SchemaObject; +import io.github.springwolf.core.asyncapi.scanners.common.payload.NamedSchemaObject; import java.util.List; import java.util.Map; @@ -22,7 +23,7 @@ public class AsyncHeadersNotDocumented implements AsyncHeadersBuilder { } @Override - public SchemaObject buildHeaders(Class<?> payloadType) { + public SchemaObject buildHeaders(NamedSchemaObject payloadSchema) { return NOT_DOCUMENTED; } } diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/headers/AsyncHeadersNotUsed.java b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/headers/AsyncHeadersNotUsed.java index 19ffed26..8b026f07 100644 --- a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/headers/AsyncHeadersNotUsed.java +++ b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/headers/AsyncHeadersNotUsed.java @@ -2,6 +2,7 @@ package io.github.springwolf.core.asyncapi.components.headers; import io.github.springwolf.asyncapi.v3.model.schema.SchemaObject; +import io.github.springwolf.core.asyncapi.scanners.common.payload.NamedSchemaObject; import java.util.List; import java.util.Map; @@ -21,7 +22,7 @@ public class AsyncHeadersNotUsed implements AsyncHeadersBuilder { } @Override - public SchemaObject buildHeaders(Class<?> payloadType) { + public SchemaObject buildHeaders(NamedSchemaObject payloadSchema) { return NOT_USED; } } diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/channels/AsyncAnnotationChannelsScanner.java b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/channels/AsyncAnnotationChannelsScanner.java index 253e1c7c..7c28ddab 100644 --- a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/channels/AsyncAnnotationChannelsScanner.java +++ b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/channels/AsyncAnnotationChannelsScanner.java @@ -15,6 +15,7 @@ import io.github.springwolf.core.asyncapi.scanners.bindings.operations.Operation import io.github.springwolf.core.asyncapi.scanners.classes.ClassScanner; import io.github.springwolf.core.asyncapi.scanners.common.AsyncAnnotationScanner; import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadClassExtractor; +import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadService; import io.github.springwolf.core.asyncapi.scanners.common.utils.AsyncAnnotationUtil; import io.github.springwolf.core.configuration.docket.AsyncApiDocketService; import lombok.extern.slf4j.Slf4j; @@ -36,11 +37,13 @@ public class AsyncAnnotationChannelsScanner<A extends Annotation> extends AsyncA ComponentsService componentsService, AsyncApiDocketService asyncApiDocketService, PayloadClassExtractor payloadClassExtractor, + PayloadService payloadService, List<OperationBindingProcessor> operationBindingProcessors, List<MessageBindingProcessor> messageBindingProcessors) { super( asyncAnnotationProvider, payloadClassExtractor, + payloadService, componentsService, operationBindingProcessors, messageBindingProcessors); diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/channels/annotations/SpringAnnotationClassLevelChannelsScanner.java b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/channels/annotations/SpringAnnotationClassLevelChannelsScanner.java index d86fff29..22d88226 100644 --- a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/channels/annotations/SpringAnnotationClassLevelChannelsScanner.java +++ b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/channels/annotations/SpringAnnotationClassLevelChannelsScanner.java @@ -8,7 +8,7 @@ import io.github.springwolf.core.asyncapi.components.ComponentsService; import io.github.springwolf.core.asyncapi.components.headers.AsyncHeadersBuilder; import io.github.springwolf.core.asyncapi.scanners.bindings.BindingFactory; import io.github.springwolf.core.asyncapi.scanners.common.ClassLevelAnnotationScanner; -import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadClassExtractor; +import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadService; import io.github.springwolf.core.asyncapi.scanners.common.utils.AnnotationScannerUtil; import lombok.extern.slf4j.Slf4j; @@ -30,14 +30,14 @@ public class SpringAnnotationClassLevelChannelsScanner< Class<MethodAnnotation> methodAnnotationClass, BindingFactory<ClassAnnotation> bindingFactory, AsyncHeadersBuilder asyncHeadersBuilder, - PayloadClassExtractor payloadClassExtractor, + PayloadService payloadService, ComponentsService componentsService) { super( classAnnotationClass, methodAnnotationClass, bindingFactory, asyncHeadersBuilder, - payloadClassExtractor, + payloadService, componentsService); } diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/channels/annotations/SpringAnnotationMethodLevelChannelsScanner.java b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/channels/annotations/SpringAnnotationMethodLevelChannelsScanner.java index c2942147..2321fa21 100644 --- a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/channels/annotations/SpringAnnotationMethodLevelChannelsScanner.java +++ b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/channels/annotations/SpringAnnotationMethodLevelChannelsScanner.java @@ -9,7 +9,8 @@ import io.github.springwolf.core.asyncapi.components.ComponentsService; import io.github.springwolf.core.asyncapi.components.headers.AsyncHeadersBuilder; import io.github.springwolf.core.asyncapi.scanners.bindings.BindingFactory; import io.github.springwolf.core.asyncapi.scanners.common.MethodLevelAnnotationScanner; -import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadClassExtractor; +import io.github.springwolf.core.asyncapi.scanners.common.payload.NamedSchemaObject; +import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadService; import io.github.springwolf.core.asyncapi.scanners.common.utils.AnnotationScannerUtil; import lombok.extern.slf4j.Slf4j; @@ -25,17 +26,17 @@ public class SpringAnnotationMethodLevelChannelsScanner<MethodAnnotation extends extends MethodLevelAnnotationScanner<MethodAnnotation> implements SpringAnnotationChannelsScannerDelegator { private final Class<MethodAnnotation> methodAnnotationClass; - private final PayloadClassExtractor payloadClassExtractor; + private final PayloadService payloadService; public SpringAnnotationMethodLevelChannelsScanner( Class<MethodAnnotation> methodAnnotationClass, BindingFactory<MethodAnnotation> bindingFactory, AsyncHeadersBuilder asyncHeadersBuilder, - PayloadClassExtractor payloadClassExtractor, + PayloadService payloadService, ComponentsService componentsService) { super(bindingFactory, asyncHeadersBuilder, componentsService); this.methodAnnotationClass = methodAnnotationClass; - this.payloadClassExtractor = payloadClassExtractor; + this.payloadService = payloadService; } @Override @@ -56,16 +57,15 @@ public class SpringAnnotationMethodLevelChannelsScanner<MethodAnnotation extends MethodAnnotation annotation = AnnotationScannerUtil.findAnnotationOrThrow(methodAnnotationClass, method); + NamedSchemaObject payloadSchema = payloadService.extractSchema(method); + ChannelObject channelItem = buildChannelItem(annotation, payloadSchema); + String channelName = bindingFactory.getChannelName(annotation); - Class<?> payload = payloadClassExtractor.extractFrom(method); - - ChannelObject channelItem = buildChannelItem(annotation, payload); - return Map.entry(channelName, channelItem); } - private ChannelObject buildChannelItem(MethodAnnotation annotation, Class<?> payloadType) { - MessageObject message = buildMessage(annotation, payloadType); + private ChannelObject buildChannelItem(MethodAnnotation annotation, NamedSchemaObject payloadSchema) { + MessageObject message = buildMessage(annotation, payloadSchema); return buildChannelItem(annotation, message); } diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/AsyncAnnotationScanner.java b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/AsyncAnnotationScanner.java index 0dbba50d..48884d26 100644 --- a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/AsyncAnnotationScanner.java +++ b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/AsyncAnnotationScanner.java @@ -17,7 +17,9 @@ import io.github.springwolf.core.asyncapi.annotations.AsyncOperation; import io.github.springwolf.core.asyncapi.components.ComponentsService; import io.github.springwolf.core.asyncapi.scanners.bindings.messages.MessageBindingProcessor; import io.github.springwolf.core.asyncapi.scanners.bindings.operations.OperationBindingProcessor; +import io.github.springwolf.core.asyncapi.scanners.common.payload.NamedSchemaObject; import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadClassExtractor; +import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadService; import io.github.springwolf.core.asyncapi.scanners.common.utils.AnnotationScannerUtil; import io.github.springwolf.core.asyncapi.scanners.common.utils.AsyncAnnotationUtil; import io.github.springwolf.core.asyncapi.scanners.common.utils.TextUtils; @@ -42,6 +44,7 @@ public abstract class AsyncAnnotationScanner<A extends Annotation> implements Em protected final AsyncAnnotationProvider<A> asyncAnnotationProvider; protected final PayloadClassExtractor payloadClassExtractor; + protected final PayloadService payloadService; protected final ComponentsService componentsService; protected final List<OperationBindingProcessor> operationBindingProcessors; protected final List<MessageBindingProcessor> messageBindingProcessors; @@ -89,30 +92,33 @@ public abstract class AsyncAnnotationScanner<A extends Annotation> implements Em } protected MessageObject buildMessage(AsyncOperation operationData, Method method) { - Class<?> payloadType = operationData.payloadType() != Object.class - ? operationData.payloadType() - : payloadClassExtractor.extractFrom(method); + NamedSchemaObject payloadSchema = payloadService.extractSchema(operationData, method); - String modelName = this.componentsService.registerSchema( - payloadType, operationData.message().contentType()); - SchemaObject asyncHeaders = AsyncAnnotationUtil.getAsyncHeaders(operationData, resolver); - String headerModelName = this.componentsService.registerSchema(asyncHeaders); - var headers = MessageHeaders.of(MessageReference.toSchema(headerModelName)); - - var schema = payloadType.getAnnotation(Schema.class); - String description = schema != null ? schema.description() : null; + // TODO: move block to own HeaderService + SchemaObject headerSchema = AsyncAnnotationUtil.getAsyncHeaders(operationData, resolver); + String headerSchemaName = this.componentsService.registerSchema(headerSchema); + var headers = MessageHeaders.of(MessageReference.toSchema(headerSchemaName)); Map<String, MessageBinding> messageBinding = AsyncAnnotationUtil.processMessageBindingFromAnnotation(method, messageBindingProcessors); var messagePayload = MessagePayload.of(MultiFormatSchema.builder() - .schema(SchemaReference.fromSchema(modelName)) + .schema(SchemaReference.fromSchema(payloadSchema.name())) .build()); + String description = operationData.message().description(); + if (!StringUtils.hasText(description)) { + description = payloadSchema.schema().getDescription(); + } + if (StringUtils.hasText(description)) { + description = this.resolver.resolveStringValue(description); + description = TextUtils.trimIndent(description); + } + var builder = MessageObject.builder() - .messageId(payloadType.getName()) - .name(payloadType.getName()) - .title(payloadType.getSimpleName()) + .messageId(payloadSchema.name()) + .name(payloadSchema.name()) + .title(payloadSchema.schema().getTitle()) .description(description) .payload(messagePayload) .headers(headers) diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/ClassLevelAnnotationScanner.java b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/ClassLevelAnnotationScanner.java index f814e939..8a7f6507 100644 --- a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/ClassLevelAnnotationScanner.java +++ b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/ClassLevelAnnotationScanner.java @@ -11,7 +11,8 @@ import io.github.springwolf.asyncapi.v3.model.schema.SchemaReference; import io.github.springwolf.core.asyncapi.components.ComponentsService; import io.github.springwolf.core.asyncapi.components.headers.AsyncHeadersBuilder; import io.github.springwolf.core.asyncapi.scanners.bindings.BindingFactory; -import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadClassExtractor; +import io.github.springwolf.core.asyncapi.scanners.common.payload.NamedSchemaObject; +import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadService; import io.github.springwolf.core.asyncapi.scanners.common.utils.AnnotationScannerUtil; import io.github.springwolf.core.asyncapi.scanners.operations.annotations.SpringAnnotationClassLevelOperationsScanner; import lombok.RequiredArgsConstructor; @@ -37,7 +38,7 @@ public abstract class ClassLevelAnnotationScanner< protected final Class<MethodAnnotation> methodAnnotationClass; protected final BindingFactory<ClassAnnotation> bindingFactory; protected final AsyncHeadersBuilder asyncHeadersBuilder; - protected final PayloadClassExtractor payloadClassExtractor; + protected final PayloadService payloadService; protected final ComponentsService componentsService; protected enum MessageType { @@ -67,8 +68,8 @@ public abstract class ClassLevelAnnotationScanner< SpringAnnotationClassLevelOperationsScanner.MessageType messageType) { Set<MessageObject> messages = methods.stream() .map((Method method) -> { - Class<?> payloadType = payloadClassExtractor.extractFrom(method); - return buildMessage(classAnnotation, payloadType); + NamedSchemaObject payloadSchema = payloadService.extractSchema(method); + return buildMessage(classAnnotation, payloadSchema); }) .collect(toSet()); @@ -79,18 +80,19 @@ public abstract class ClassLevelAnnotationScanner< return toMessagesMap(messages); } - protected MessageObject buildMessage(ClassAnnotation classAnnotation, Class<?> payloadType) { + protected MessageObject buildMessage(ClassAnnotation classAnnotation, NamedSchemaObject payloadSchema) { Map<String, MessageBinding> messageBinding = bindingFactory.buildMessageBinding(classAnnotation); - String modelName = componentsService.registerSchema(payloadType); - String headerModelName = componentsService.registerSchema(asyncHeadersBuilder.buildHeaders(payloadType)); + + String headerModelName = componentsService.registerSchema(asyncHeadersBuilder.buildHeaders(payloadSchema)); + MessagePayload payload = MessagePayload.of(MultiFormatSchema.builder() - .schema(SchemaReference.fromSchema(modelName)) + .schema(SchemaReference.fromSchema(payloadSchema.name())) .build()); MessageObject message = MessageObject.builder() - .messageId(payloadType.getName()) - .name(payloadType.getName()) - .title(payloadType.getSimpleName()) + .messageId(payloadSchema.name()) + .name(payloadSchema.name()) + .title(payloadSchema.schema().getTitle()) .description(null) .payload(payload) .headers(MessageHeaders.of(MessageReference.toSchema(headerModelName))) diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/MethodLevelAnnotationScanner.java b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/MethodLevelAnnotationScanner.java index 1d548122..72f5e823 100644 --- a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/MethodLevelAnnotationScanner.java +++ b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/MethodLevelAnnotationScanner.java @@ -11,6 +11,7 @@ import io.github.springwolf.asyncapi.v3.model.schema.SchemaReference; import io.github.springwolf.core.asyncapi.components.ComponentsService; import io.github.springwolf.core.asyncapi.components.headers.AsyncHeadersBuilder; import io.github.springwolf.core.asyncapi.scanners.bindings.BindingFactory; +import io.github.springwolf.core.asyncapi.scanners.common.payload.NamedSchemaObject; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; @@ -25,18 +26,20 @@ public abstract class MethodLevelAnnotationScanner<MethodAnnotation extends Anno protected final AsyncHeadersBuilder asyncHeadersBuilder; protected final ComponentsService componentsService; - protected MessageObject buildMessage(MethodAnnotation annotation, Class<?> payloadType) { + protected MessageObject buildMessage(MethodAnnotation annotation, NamedSchemaObject payloadSchema) { Map<String, MessageBinding> messageBinding = bindingFactory.buildMessageBinding(annotation); - String modelName = componentsService.registerSchema(payloadType); - String headerModelName = componentsService.registerSchema(asyncHeadersBuilder.buildHeaders(payloadType)); + + // TODO: move block to own HeaderService + String headerModelName = componentsService.registerSchema(asyncHeadersBuilder.buildHeaders(payloadSchema)); + MessagePayload payload = MessagePayload.of(MultiFormatSchema.builder() - .schema(SchemaReference.fromSchema(modelName)) + .schema(SchemaReference.fromSchema(payloadSchema.name())) .build()); MessageObject message = MessageObject.builder() - .messageId(payloadType.getName()) - .name(payloadType.getName()) - .title(payloadType.getSimpleName()) + .messageId(payloadSchema.name()) + .name(payloadSchema.name()) + .title(payloadSchema.schema().getTitle()) .description(null) .payload(payload) .headers(MessageHeaders.of(MessageReference.toSchema(headerModelName))) diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/payload/NamedSchemaObject.java b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/payload/NamedSchemaObject.java new file mode 100644 index 00000000..9509becf --- /dev/null +++ b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/payload/NamedSchemaObject.java @@ -0,0 +1,11 @@ +// SPDX-License-Identifier: Apache-2.0 +package io.github.springwolf.core.asyncapi.scanners.common.payload; + +import io.github.springwolf.asyncapi.v3.model.schema.SchemaObject; + +/** + * Encapsulates the resolved name for the contained schema. + * @param name The fully qualified name or the simple name of the schema. + * @param schema The SchemaObject. + */ +public record NamedSchemaObject(String name, SchemaObject schema) {} diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/payload/PayloadClassExtractor.java b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/payload/PayloadClassExtractor.java index 0d19c5e6..9e80ef74 100644 --- a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/payload/PayloadClassExtractor.java +++ b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/payload/PayloadClassExtractor.java @@ -1,52 +1,34 @@ // SPDX-License-Identifier: Apache-2.0 package io.github.springwolf.core.asyncapi.scanners.common.payload; -import io.github.springwolf.core.configuration.properties.SpringwolfConfigProperties; import lombok.RequiredArgsConstructor; import lombok.extern.slf4j.Slf4j; import org.springframework.messaging.handler.annotation.Payload; import java.lang.annotation.Annotation; import java.lang.reflect.Method; -import java.lang.reflect.ParameterizedType; -import java.lang.reflect.Type; import java.util.Arrays; -import java.util.Map; +import java.util.Optional; +@RequiredArgsConstructor @Slf4j public class PayloadClassExtractor { private final TypeToClassConverter typeToClassConverter; - public PayloadClassExtractor(SpringwolfConfigProperties properties) { - Map<String, Integer> extractableClasses = Map.of(); - if (properties.getPayload() != null) { - extractableClasses = properties.getPayload().getExtractableClasses(); - } - typeToClassConverter = new TypeToClassConverter(extractableClasses); - } - - public Class<?> extractFrom(Method method) { + public Optional<Class<?>> extractFrom(Method method) { String methodName = String.format("%s::%s", method.getDeclaringClass().getSimpleName(), method.getName()); log.debug("Finding payload type for {}", methodName); - int parameterPayloadIndex = - getPayloadParameterIndex(method.getParameterTypes(), method.getParameterAnnotations(), methodName); - - return typeToClassConverter.extractClass(method.getGenericParameterTypes()[parameterPayloadIndex]); + return getPayloadParameterIndex(method.getParameterTypes(), method.getParameterAnnotations(), methodName) + .map((parameterPayloadIndex) -> + typeToClassConverter.extractClass(method.getGenericParameterTypes()[parameterPayloadIndex])); } - public Class<?> typeToClass(Type type) { - return typeToClassConverter.extractClass(type); - } - - private int getPayloadParameterIndex( + private Optional<Integer> getPayloadParameterIndex( Class<?>[] parameterClasses, Annotation[][] parameterAnnotations, String methodName) { - switch (parameterClasses.length) { - case 0 -> throw new IllegalArgumentException( - "Payload cannot be detected. Method must not have 0 parameters: " + methodName); - case 1 -> { - return 0; - } + return switch (parameterClasses.length) { + case 0 -> Optional.empty(); + case 1 -> Optional.of(0); default -> { int payloadAnnotatedParameterIndex = getPayloadAnnotatedParameterIndex(parameterAnnotations); if (payloadAnnotatedParameterIndex == -1) { @@ -57,9 +39,9 @@ public class PayloadClassExtractor { throw new IllegalArgumentException(msg); } - return payloadAnnotatedParameterIndex; + yield Optional.of(payloadAnnotatedParameterIndex); } - } + }; } private int getPayloadAnnotatedParameterIndex(Annotation[][] parameterAnnotations) { @@ -74,58 +56,4 @@ public class PayloadClassExtractor { return -1; } - - @RequiredArgsConstructor - private static class TypeToClassConverter { - - private final Map<String, Integer> extractableClassToArgumentIndex; - - private Class<?> extractClass(Type parameterType) { - try { - if (parameterType instanceof ParameterizedType) { - Type rawParameterType = ((ParameterizedType) parameterType).getRawType(); - String rawParameterTypeName = rawParameterType.getTypeName(); - - Class<?> actualPayloadClass = - extractActualGenericClass((ParameterizedType) parameterType, rawParameterTypeName); - if (actualPayloadClass != Void.class) { - return actualPayloadClass; - } - - // nested generic class - fallback to most outer container - return Class.forName(rawParameterTypeName); - } - - // no generics used - just a normal type - return Class.forName(parameterType.getTypeName()); - } catch (Exception ex) { - log.info("Unable to extract generic data type of {}", parameterType, ex); - } - return Void.class; - } - - private Class<?> extractActualGenericClass(ParameterizedType parameterType, String rawParameterTypeName) { - Type type = parameterType; - String typeName = rawParameterTypeName; - - while (type instanceof ParameterizedType && extractableClassToArgumentIndex.containsKey(typeName)) { - Integer index = extractableClassToArgumentIndex.get(rawParameterTypeName); - - type = ((ParameterizedType) type).getActualTypeArguments()[index]; - - typeName = type.getTypeName(); - if (type instanceof ParameterizedType) { - typeName = ((ParameterizedType) type).getRawType().getTypeName(); - } - } - - try { - return Class.forName(typeName); - } catch (ClassNotFoundException ex) { - log.debug("Unable to find class for type {}", typeName, ex); - } - - return Void.class; - } - } } diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/payload/PayloadService.java b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/payload/PayloadService.java new file mode 100644 index 00000000..69342a90 --- /dev/null +++ b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/payload/PayloadService.java @@ -0,0 +1,60 @@ +// SPDX-License-Identifier: Apache-2.0 +package io.github.springwolf.core.asyncapi.scanners.common.payload; + +import io.github.springwolf.asyncapi.v3.model.schema.SchemaObject; +import io.github.springwolf.core.asyncapi.annotations.AsyncOperation; +import io.github.springwolf.core.asyncapi.components.ComponentsService; +import io.github.springwolf.core.configuration.properties.SpringwolfConfigProperties; +import lombok.RequiredArgsConstructor; +import lombok.extern.slf4j.Slf4j; + +import java.lang.reflect.Method; +import java.util.Map; +import java.util.Optional; + +@Slf4j +@RequiredArgsConstructor +public class PayloadService { + private final PayloadClassExtractor payloadClassExtractor; + private final ComponentsService componentsService; + private final SpringwolfConfigProperties properties; + + private static final String PAYLOAD_NOT_USED_KEY = "PayloadNotUsed"; + static final NamedSchemaObject PAYLOAD_NOT_USED = new NamedSchemaObject( + PAYLOAD_NOT_USED_KEY, + SchemaObject.builder() + .title(PAYLOAD_NOT_USED_KEY) + .description("No payload specified") + .properties(Map.of()) + .build()); + + public NamedSchemaObject extractSchema(Method method) { + Optional<Class<?>> payloadType = payloadClassExtractor.extractFrom(method); + + String contentType = properties.getDocket().getDefaultContentType(); + return payloadType.map((type) -> buildSchema(contentType, type)).orElseGet(this::useUnusedPayload); + } + + public NamedSchemaObject extractSchema(AsyncOperation operationData, Method method) { + Optional<Class<?>> payloadType = operationData.payloadType() != Object.class + ? Optional.of(operationData.payloadType()) + : payloadClassExtractor.extractFrom(method); + + String contentType = operationData.message().contentType(); + return payloadType.map((type) -> buildSchema(contentType, type)).orElseGet(this::useUnusedPayload); + } + + private NamedSchemaObject buildSchema(String contentType, Class<?> payloadType) { + String componentsSchemaName = this.componentsService.registerSchema(payloadType, contentType); + + SchemaObject schema = componentsService.resolveSchema(componentsSchemaName); + schema.setTitle(payloadType.getSimpleName()); + + return new NamedSchemaObject(componentsSchemaName, schema); + } + + private NamedSchemaObject useUnusedPayload() { + this.componentsService.registerSchema(PAYLOAD_NOT_USED.schema()); + return PAYLOAD_NOT_USED; + } +} diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/payload/TypeToClassConverter.java b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/payload/TypeToClassConverter.java new file mode 100644 index 00000000..c55f8254 --- /dev/null +++ b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/common/payload/TypeToClassConverter.java @@ -0,0 +1,71 @@ +// SPDX-License-Identifier: Apache-2.0 +package io.github.springwolf.core.asyncapi.scanners.common.payload; + +import io.github.springwolf.core.configuration.properties.SpringwolfConfigProperties; +import lombok.extern.slf4j.Slf4j; + +import java.lang.reflect.ParameterizedType; +import java.lang.reflect.Type; +import java.util.Map; + +@Slf4j +public class TypeToClassConverter { + + private final Map<String, Integer> extractableClassToArgumentIndex; + + public TypeToClassConverter(SpringwolfConfigProperties properties) { + if (properties.getPayload() != null) { + extractableClassToArgumentIndex = properties.getPayload().getExtractableClasses(); + } else { + extractableClassToArgumentIndex = Map.of(); + } + } + + public Class<?> extractClass(Type parameterType) { + try { + if (parameterType instanceof ParameterizedType) { + Type rawParameterType = ((ParameterizedType) parameterType).getRawType(); + String rawParameterTypeName = rawParameterType.getTypeName(); + + Class<?> actualPayloadClass = + extractActualGenericClass((ParameterizedType) parameterType, rawParameterTypeName); + if (actualPayloadClass != Void.class) { + return actualPayloadClass; + } + + // nested generic class - fallback to most outer container + return Class.forName(rawParameterTypeName); + } + + // no generics used - just a normal type + return Class.forName(parameterType.getTypeName()); + } catch (Exception ex) { + log.info("Unable to extract generic data type of %s".formatted(parameterType), ex); + } + return Void.class; + } + + private Class<?> extractActualGenericClass(ParameterizedType parameterType, String rawParameterTypeName) { + Type type = parameterType; + String typeName = rawParameterTypeName; + + while (type instanceof ParameterizedType && extractableClassToArgumentIndex.containsKey(typeName)) { + Integer index = extractableClassToArgumentIndex.get(rawParameterTypeName); + + type = ((ParameterizedType) type).getActualTypeArguments()[index]; + + typeName = type.getTypeName(); + if (type instanceof ParameterizedType) { + typeName = ((ParameterizedType) type).getRawType().getTypeName(); + } + } + + try { + return Class.forName(typeName); + } catch (ClassNotFoundException ex) { + log.debug("Unable to find class for type %s".formatted(typeName), ex); + } + + return Void.class; + } +} diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/operations/annotations/AsyncAnnotationOperationsScanner.java b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/operations/annotations/AsyncAnnotationOperationsScanner.java index 6cee589b..16ac6204 100644 --- a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/operations/annotations/AsyncAnnotationOperationsScanner.java +++ b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/operations/annotations/AsyncAnnotationOperationsScanner.java @@ -10,6 +10,7 @@ import io.github.springwolf.core.asyncapi.scanners.bindings.operations.Operation import io.github.springwolf.core.asyncapi.scanners.classes.ClassScanner; import io.github.springwolf.core.asyncapi.scanners.common.AsyncAnnotationScanner; import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadClassExtractor; +import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadService; import io.github.springwolf.core.asyncapi.scanners.operations.OperationMerger; import lombok.extern.slf4j.Slf4j; @@ -28,11 +29,13 @@ public class AsyncAnnotationOperationsScanner<A extends Annotation> extends Asyn ClassScanner classScanner, ComponentsService componentsService, PayloadClassExtractor payloadClassExtractor, + PayloadService payloadService, List<OperationBindingProcessor> operationBindingProcessors, List<MessageBindingProcessor> messageBindingProcessors) { super( asyncAnnotationProvider, payloadClassExtractor, + payloadService, componentsService, operationBindingProcessors, messageBindingProcessors); diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/operations/annotations/SpringAnnotationClassLevelOperationsScanner.java b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/operations/annotations/SpringAnnotationClassLevelOperationsScanner.java index 74b0db0c..81166950 100644 --- a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/operations/annotations/SpringAnnotationClassLevelOperationsScanner.java +++ b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/operations/annotations/SpringAnnotationClassLevelOperationsScanner.java @@ -10,7 +10,7 @@ import io.github.springwolf.core.asyncapi.components.ComponentsService; import io.github.springwolf.core.asyncapi.components.headers.AsyncHeadersBuilder; import io.github.springwolf.core.asyncapi.scanners.bindings.BindingFactory; import io.github.springwolf.core.asyncapi.scanners.common.ClassLevelAnnotationScanner; -import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadClassExtractor; +import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadService; import io.github.springwolf.core.asyncapi.scanners.common.utils.AnnotationScannerUtil; import lombok.extern.slf4j.Slf4j; @@ -32,14 +32,14 @@ public class SpringAnnotationClassLevelOperationsScanner< Class<MethodAnnotation> methodAnnotationClass, BindingFactory<ClassAnnotation> bindingFactory, AsyncHeadersBuilder asyncHeadersBuilder, - PayloadClassExtractor payloadClassExtractor, + PayloadService payloadService, ComponentsService componentsService) { super( classAnnotationClass, methodAnnotationClass, bindingFactory, asyncHeadersBuilder, - payloadClassExtractor, + payloadService, componentsService); } diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/operations/annotations/SpringAnnotationMethodLevelOperationsScanner.java b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/operations/annotations/SpringAnnotationMethodLevelOperationsScanner.java index e222893f..ac5448ac 100644 --- a/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/operations/annotations/SpringAnnotationMethodLevelOperationsScanner.java +++ b/springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/scanners/operations/annotations/SpringAnnotationMethodLevelOperationsScanner.java @@ -11,7 +11,8 @@ import io.github.springwolf.core.asyncapi.components.ComponentsService; import io.github.springwolf.core.asyncapi.components.headers.AsyncHeadersBuilder; import io.github.springwolf.core.asyncapi.scanners.bindings.BindingFactory; import io.github.springwolf.core.asyncapi.scanners.common.MethodLevelAnnotationScanner; -import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadClassExtractor; +import io.github.springwolf.core.asyncapi.scanners.common.payload.NamedSchemaObject; +import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadService; import io.github.springwolf.core.asyncapi.scanners.common.utils.AnnotationScannerUtil; import lombok.extern.slf4j.Slf4j; @@ -28,17 +29,17 @@ public class SpringAnnotationMethodLevelOperationsScanner<MethodAnnotation exten extends MethodLevelAnnotationScanner<MethodAnnotation> implements SpringAnnotationOperationsScannerDelegator { private final Class<MethodAnnotation> methodAnnotationClass; - private final PayloadClassExtractor payloadClassExtractor; + private final PayloadService payloadService; public SpringAnnotationMethodLevelOperationsScanner( Class<MethodAnnotation> methodAnnotationClass, BindingFactory<MethodAnnotation> bindingFactory, AsyncHeadersBuilder asyncHeadersBuilder, - PayloadClassExtractor payloadClassExtractor, + PayloadService payloadService, ComponentsService componentsService) { super(bindingFactory, asyncHeadersBuilder, componentsService); this.methodAnnotationClass = methodAnnotationClass; - this.payloadClassExtractor = payloadClassExtractor; + this.payloadService = payloadService; } @Override @@ -61,13 +62,13 @@ public class SpringAnnotationMethodLevelOperationsScanner<MethodAnnotation exten String channelName = bindingFactory.getChannelName(annotation); String operationId = channelName + "_" + OperationAction.RECEIVE + "_" + method.getName(); - Class<?> payload = payloadClassExtractor.extractFrom(method); + NamedSchemaObject payloadSchema = payloadService.extractSchema(method); - Operation operation = buildOperation(annotation, payload); + Operation operation = buildOperation(annotation, payloadSchema); return Map.entry(operationId, operation); } - private Operation buildOperation(MethodAnnotation annotation, Class<?> payloadType) { + private Operation buildOperation(MethodAnnotation annotation, NamedSchemaObject payloadType) { MessageObject message = buildMessage(annotation, payloadType); return buildOperation(annotation, message); } diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/configuration/SpringwolfAutoConfiguration.java b/springwolf-core/src/main/java/io/github/springwolf/core/configuration/SpringwolfAutoConfiguration.java index b8284b26..2851142c 100644 --- a/springwolf-core/src/main/java/io/github/springwolf/core/configuration/SpringwolfAutoConfiguration.java +++ b/springwolf-core/src/main/java/io/github/springwolf/core/configuration/SpringwolfAutoConfiguration.java @@ -28,6 +28,8 @@ import io.github.springwolf.core.asyncapi.operations.OperationsService; import io.github.springwolf.core.asyncapi.scanners.ChannelsScanner; import io.github.springwolf.core.asyncapi.scanners.OperationsScanner; import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadClassExtractor; +import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadService; +import io.github.springwolf.core.asyncapi.scanners.common.payload.TypeToClassConverter; import io.github.springwolf.core.configuration.docket.AsyncApiDocketService; import io.github.springwolf.core.configuration.docket.DefaultAsyncApiDocketService; import io.github.springwolf.core.configuration.properties.SpringwolfConfigConstants; @@ -161,7 +163,22 @@ public class SpringwolfAutoConfiguration { @Bean @ConditionalOnMissingBean - public PayloadClassExtractor payloadClassExtractor(SpringwolfConfigProperties springwolfConfigProperties) { - return new PayloadClassExtractor(springwolfConfigProperties); + public TypeToClassConverter typeToClassConverter(SpringwolfConfigProperties springwolfConfigProperties) { + return new TypeToClassConverter(springwolfConfigProperties); + } + + @Bean + @ConditionalOnMissingBean + public PayloadClassExtractor payloadClassExtractor(TypeToClassConverter typeToClassConverter) { + return new PayloadClassExtractor(typeToClassConverter); + } + + @Bean + @ConditionalOnMissingBean + public PayloadService payloadService( + PayloadClassExtractor payloadClassExtractor, + ComponentsService componentsService, + SpringwolfConfigProperties properties) { + return new PayloadService(payloadClassExtractor, componentsService, properties); } } diff --git a/springwolf-core/src/main/java/io/github/springwolf/core/configuration/SpringwolfScannerConfiguration.java b/springwolf-core/src/main/java/io/github/springwolf/core/configuration/SpringwolfScannerConfiguration.java index a0c9e7d8..ab416da7 100644 --- a/springwolf-core/src/main/java/io/github/springwolf/core/configuration/SpringwolfScannerConfiguration.java +++ b/springwolf-core/src/main/java/io/github/springwolf/core/configuration/SpringwolfScannerConfiguration.java @@ -17,6 +17,7 @@ import io.github.springwolf.core.asyncapi.scanners.classes.spring.ComponentClass import io.github.springwolf.core.asyncapi.scanners.classes.spring.ConfigurationClassScanner; import io.github.springwolf.core.asyncapi.scanners.common.AsyncAnnotationScanner; import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadClassExtractor; +import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadService; import io.github.springwolf.core.asyncapi.scanners.operations.annotations.AsyncAnnotationOperationsScanner; import io.github.springwolf.core.configuration.docket.AsyncApiDocketService; import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; @@ -74,6 +75,7 @@ public class SpringwolfScannerConfiguration { ComponentsService componentsService, AsyncApiDocketService asyncApiDocketService, PayloadClassExtractor payloadClassExtractor, + PayloadService payloadService, List<OperationBindingProcessor> operationBindingProcessors, List<MessageBindingProcessor> messageBindingProcessors) { return new AsyncAnnotationChannelsScanner<>( @@ -82,6 +84,7 @@ public class SpringwolfScannerConfiguration { componentsService, asyncApiDocketService, payloadClassExtractor, + payloadService, operationBindingProcessors, messageBindingProcessors); } @@ -96,6 +99,7 @@ public class SpringwolfScannerConfiguration { SpringwolfClassScanner springwolfClassScanner, ComponentsService componentsService, PayloadClassExtractor payloadClassExtractor, + PayloadService payloadService, List<OperationBindingProcessor> operationBindingProcessors, List<MessageBindingProcessor> messageBindingProcessors) { return new AsyncAnnotationOperationsScanner<>( @@ -103,6 +107,7 @@ public class SpringwolfScannerConfiguration { springwolfClassScanner, componentsService, payloadClassExtractor, + payloadService, operationBindingProcessors, messageBindingProcessors); } @@ -118,6 +123,7 @@ public class SpringwolfScannerConfiguration { ComponentsService componentsService, AsyncApiDocketService asyncApiDocketService, PayloadClassExtractor payloadClassExtractor, + PayloadService payloadService, List<OperationBindingProcessor> operationBindingProcessors, List<MessageBindingProcessor> messageBindingProcessors) { return new AsyncAnnotationChannelsScanner<>( @@ -126,6 +132,7 @@ public class SpringwolfScannerConfiguration { componentsService, asyncApiDocketService, payloadClassExtractor, + payloadService, operationBindingProcessors, messageBindingProcessors); } @@ -140,6 +147,7 @@ public class SpringwolfScannerConfiguration { SpringwolfClassScanner springwolfClassScanner, ComponentsService componentsService, PayloadClassExtractor payloadClassExtractor, + PayloadService payloadService, List<OperationBindingProcessor> operationBindingProcessors, List<MessageBindingProcessor> messageBindingProcessors) { return new AsyncAnnotationOperationsScanner<>( @@ -147,6 +155,7 @@ public class SpringwolfScannerConfiguration { springwolfClassScanner, componentsService, payloadClassExtractor, + payloadService, operationBindingProcessors, messageBindingProcessors); } diff --git a/springwolf-core/src/test/java/io/github/springwolf/core/asyncapi/scanners/channels/annotations/AsyncAnnotationChannelsScannerTest.java b/springwolf-core/src/test/java/io/github/springwolf/core/asyncapi/scanners/channels/annotations/AsyncAnnotationChannelsScannerTest.java index 39b2002d..7e4bdb5c 100644 --- a/springwolf-core/src/test/java/io/github/springwolf/core/asyncapi/scanners/channels/annotations/AsyncAnnotationChannelsScannerTest.java +++ b/springwolf-core/src/test/java/io/github/springwolf/core/asyncapi/scanners/channels/annotations/AsyncAnnotationChannelsScannerTest.java @@ -28,6 +28,8 @@ import io.github.springwolf.core.asyncapi.scanners.channels.AsyncAnnotationChann import io.github.springwolf.core.asyncapi.scanners.classes.ClassScanner; import io.github.springwolf.core.asyncapi.scanners.common.AsyncAnnotationScanner; import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadClassExtractor; +import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadService; +import io.github.springwolf.core.asyncapi.scanners.common.payload.TypeToClassConverter; import io.github.springwolf.core.configuration.docket.AsyncApiDocket; import io.github.springwolf.core.configuration.docket.AsyncApiDocketService; import io.github.springwolf.core.configuration.properties.SpringwolfConfigProperties; @@ -85,7 +87,10 @@ class AsyncAnnotationChannelsScannerTest { new DefaultComponentsService(emptyList(), emptyList(), swaggerSchemaUtil, properties); private final AsyncApiDocketService asyncApiDocketService = mock(AsyncApiDocketService.class); - private final PayloadClassExtractor payloadClassExtractor = new PayloadClassExtractor(properties); + private final TypeToClassConverter typeToClassConverter = new TypeToClassConverter(properties); + private final PayloadClassExtractor payloadClassExtractor = new PayloadClassExtractor(typeToClassConverter); + private final PayloadService payloadService = + new PayloadService(payloadClassExtractor, componentsService, properties); private final List<OperationBindingProcessor> operationBindingProcessors = List.of(new TestOperationBindingProcessor()); @@ -99,6 +104,7 @@ class AsyncAnnotationChannelsScannerTest { componentsService, asyncApiDocketService, payloadClassExtractor, + payloadService, operationBindingProcessors, messageBindingProcessors); diff --git a/springwolf-core/src/test/java/io/github/springwolf/core/asyncapi/scanners/channels/annotations/SpringAnnotationClassLevelChannelsScannerIntegrationTest.java b/springwolf-core/src/test/java/io/github/springwolf/core/asyncapi/scanners/channels/annotations/SpringAnnotationClassLevelChannelsScannerIntegrationTest.java index 11e2dec6..3671c992 100644 --- a/springwolf-core/src/test/java/io/github/springwolf/core/asyncapi/scanners/channels/annotations/SpringAnnotationClassLevelChannelsScannerIntegrationTest.java +++ b/springwolf-core/src/test/java/io/github/springwolf/core/asyncapi/scanners/channels/annotations/SpringAnnotationClassLevelChannelsScannerIntegrationTest.java @@ -20,6 +20,8 @@ import io.github.springwolf.core.asyncapi.components.examples.walkers.json.Examp import io.github.springwolf.core.asyncapi.components.headers.AsyncHeadersNotDocumented; import io.github.springwolf.core.asyncapi.scanners.bindings.BindingFactory; import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadClassExtractor; +import io.github.springwolf.core.asyncapi.scanners.common.payload.PayloadService; +import io.github.springwolf.core.asyncapi.scanners.common.payload.TypeToClassConverter; import io.github.springwolf.core.configuration.properties.SpringwolfConfigProperties; import lombok.Data; import lombok.EqualsAndHashCode; @@ -48,7 +50,9 @@ import static org.assertj.core.api.Assertions.assertThat; SpringAnnotationClassLevelChannelsScannerIntegrationTest.TestBindingFactory.class, DefaultComponentsService.class, SwaggerSchemaUtil.class, + PayloadService.class, PayloadClassExtractor.class, + TypeToClassConverter.class, DefaultSchemaWalker.class, SchemaWalkerProvider.class, ExampleJsonValueGenerator.class, @@ -60,7 +64,7 @@ class SpringAnnotationClassLevelChannelsScannerIntegrationTest { BindingFactory<TestClassListener> bindingFactory; @Autowired - PayloadClassExtractor payloadClassExtractor; + PayloadService payloadService; @Autowired ComponentsService componentsService; @@ -74,7 +78,7 @@ class SpringAnnotationClassLevelChannelsScannerIntegrationTest { TestMethodListener.class, this.bindingFactory, new AsyncHeadersNotDocumented(), - payloadClassExtractor, + payloadService, componentsService); } diff --git a/springwolf-core/src/test/java/io/github/springwolf/core/asyncapi/scanners/channels/annotations/SpringAnnotationClassLevelChannelsScannerTest.java b/springwolf-core/src/test/java/io/github/springwolf/core/asyncapi/scanners/channels/annotations/SpringAnnotationClassLevelChannelsScannerTest.java index 9f0ba78b..601cf424 10…
1 parent efabf30 commit baa8627

File tree

60 files changed

+935
-379
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

60 files changed

+935
-379
lines changed

‎springwolf-add-ons/springwolf-common-model-converters/src/main/java/io/github/springwolf/addons/common_model_converters/converters/monetaryamount/MonetaryAmountConverter.java‎

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,32 @@ public class MonetaryAmountConverter implements ModelConverter {
1414

1515
@Override
1616
public Schema resolve(AnnotatedType type, ModelConverterContext context, Iterator<ModelConverter> chain) {
17-
JavaType javaType = Json.mapper().constructType(type.getType());
18-
if (javaType != null) {
19-
Class<?> cls = javaType.getRawClass();
20-
if (javax.money.MonetaryAmount.class.isAssignableFrom(cls))
21-
type = new AnnotatedType(MonetaryAmount.class).resolveAsRef(true);
17+
Class<?> rawClass = getRawClass(type);
18+
boolean isMonetaryAmount = isMonetaryAmountType(rawClass);
19+
20+
if (isMonetaryAmount) {
21+
type = new AnnotatedType(MonetaryAmount.class).resolveAsRef(true);
2222
}
23+
24+
Schema<?> schema = proceedWithChain(type, context, chain);
25+
26+
if (isMonetaryAmount && schema != null && rawClass != null) {
27+
schema.name(rawClass.getName());
28+
}
29+
30+
return schema;
31+
}
32+
33+
private Class<?> getRawClass(AnnotatedType type) {
34+
JavaType javaType = Json.mapper().constructType(type.getType());
35+
return javaType != null ? javaType.getRawClass() : null;
36+
}
37+
38+
private Schema proceedWithChain(AnnotatedType type, ModelConverterContext context, Iterator<ModelConverter> chain) {
2339
return (chain.hasNext()) ? chain.next().resolve(type, context, chain) : null;
2440
}
41+
42+
private boolean isMonetaryAmountType(Class<?> rawClass) {
43+
return javax.money.MonetaryAmount.class.isAssignableFrom(rawClass);
44+
}
2545
}

‎springwolf-add-ons/springwolf-common-model-converters/src/test/java/io/github/springwolf/addons/common_model_converters/converters/monetaryamount/MonetaryAmountConverterTest.java‎

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,30 @@
66
import io.swagger.v3.oas.models.media.Schema;
77
import org.junit.jupiter.api.Test;
88

9-
import javax.money.MonetaryAmount;
9+
import java.util.Map;
1010

1111
import static org.junit.jupiter.api.Assertions.assertEquals;
1212
import static org.junit.jupiter.api.Assertions.assertNotNull;
1313
import static org.junit.jupiter.api.Assertions.assertNull;
1414

1515
class MonetaryAmountConverterTest {
1616

17-
private MonetaryAmountConverter modelsConverter = new MonetaryAmountConverter();
17+
private final MonetaryAmountConverter modelsConverter = new MonetaryAmountConverter();
1818

19-
private ModelConverters converters = new ModelConverters();
19+
private final ModelConverters converters = new ModelConverters();
2020

2121
@Test
2222
void testMonetaryAmountConverter() {
23-
23+
// given
2424
converters.addConverter(modelsConverter);
2525

26-
final Schema model =
27-
converters.readAll(new AnnotatedType(MonetaryAmount.class)).get("MonetaryAmount");
26+
// when
27+
final Map<String, Schema> models = converters.readAll(new AnnotatedType(javax.money.MonetaryAmount.class));
28+
29+
// then
30+
final Schema model = models.get("MonetaryAmount");
2831
assertNotNull(model);
32+
2933
assertEquals(2, model.getProperties().size());
3034

3135
final Schema amountProperty = (Schema) model.getProperties().get("amount");
@@ -36,5 +40,12 @@ void testMonetaryAmountConverter() {
3640

3741
final Schema missingProperty = (Schema) model.getProperties().get("missing");
3842
assertNull(missingProperty);
43+
44+
// then
45+
final Schema originalModel = models.get("javax.money.MonetaryAmount");
46+
assertNotNull(originalModel);
47+
48+
assertNull(originalModel.getType());
49+
assertEquals("#/components/schemas/MonetaryAmount", originalModel.get$ref());
3950
}
4051
}

‎springwolf-asyncapi/src/main/java/io/github/springwolf/asyncapi/v3/model/channel/message/MessagePayload.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,12 @@
77
import io.github.springwolf.asyncapi.v3.model.schema.SchemaObject;
88
import lombok.EqualsAndHashCode;
99
import lombok.Getter;
10+
import lombok.ToString;
1011

1112
@Getter
1213
@JsonSerialize(using = MessagePayloadSerializer.class)
1314
@EqualsAndHashCode
15+
@ToString
1416
public class MessagePayload {
1517
private MultiFormatSchema multiFormatSchema;
1618
private SchemaObject schema;

‎springwolf-asyncapi/src/main/java/io/github/springwolf/asyncapi/v3/model/channel/message/MessageReference.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
import lombok.ToString;
1010

1111
@EqualsAndHashCode
12+
@ToString
1213
@NoArgsConstructor
1314
@AllArgsConstructor
1415
public class MessageReference implements Message, Reference {

‎springwolf-asyncapi/src/main/java/io/github/springwolf/asyncapi/v3/model/schema/SchemaObject.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
import lombok.Data;
1111
import lombok.EqualsAndHashCode;
1212
import lombok.NoArgsConstructor;
13+
import lombok.ToString;
1314

1415
import java.math.BigDecimal;
1516
import java.util.List;
@@ -31,6 +32,7 @@
3132
@NoArgsConstructor
3233
@AllArgsConstructor
3334
@EqualsAndHashCode(callSuper = true)
35+
@ToString
3436
public class SchemaObject extends ExtendableObject implements Schema {
3537
/**
3638
* Adds support for polymorphism. The discriminator is the schema property name that is used to differentiate

‎springwolf-asyncapi/src/main/java/io/github/springwolf/asyncapi/v3/model/schema/SchemaReference.java‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
import lombok.ToString;
1010

1111
@EqualsAndHashCode
12+
@ToString
1213
@NoArgsConstructor
1314
@AllArgsConstructor
1415
public class SchemaReference implements Schema, Reference {

‎springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/ComponentsService.java‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ public interface ComponentsService {
1212

1313
Map<String, SchemaObject> getSchemas();
1414

15+
SchemaObject resolveSchema(String schemaName);
16+
1517
String registerSchema(SchemaObject headers);
1618

1719
String registerSchema(Class<?> type);

‎springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/DefaultComponentsService.java‎

Lines changed: 55 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
import io.swagger.v3.oas.models.media.ObjectSchema;
1515
import io.swagger.v3.oas.models.media.Schema;
1616
import io.swagger.v3.oas.models.media.StringSchema;
17+
import jakarta.annotation.Nullable;
1718
import lombok.extern.slf4j.Slf4j;
1819
import org.apache.commons.lang3.StringUtils;
1920

@@ -60,6 +61,15 @@ public Map<String, SchemaObject> getSchemas() {
6061
.collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
6162
}
6263

64+
@Override
65+
@Nullable
66+
public SchemaObject resolveSchema(String schemaName) {
67+
if (schemas.containsKey(schemaName)) {
68+
return swaggerSchemaUtil.mapSchema(schemas.get(schemaName));
69+
}
70+
return null;
71+
}
72+
6373
@Override
6474
public String registerSchema(SchemaObject headers) {
6575
log.debug("Registering schema for {}", headers.getTitle());
@@ -81,6 +91,7 @@ public String registerSchema(SchemaObject headers) {
8191

8292
@Override
8393
public String registerSchema(Class<?> type) {
94+
// FIXME: Move this to the new HeadersService
8495
return this.registerSchema(type, properties.getDocket().getDefaultContentType());
8596
}
8697

@@ -90,13 +101,13 @@ public String registerSchema(Class<?> type, String contentType) {
90101
String actualContentType =
91102
StringUtils.isBlank(contentType) ? properties.getDocket().getDefaultContentType() : contentType;
92103

93-
Map<String, Schema> schemas = new LinkedHashMap<>(runWithFqnSetting((unused) -> converter.readAll(type)));
104+
Map<String, Schema> newSchemas = new LinkedHashMap<>(runWithFqnSetting((unused) -> converter.readAll(type)));
94105

95-
String schemaName = getSchemaName(type, schemas);
106+
String schemaName = getSchemaName(type, newSchemas);
96107

97-
preProcessSchemas(schemas, schemaName, type);
98-
schemas.forEach(this.schemas::putIfAbsent);
99-
schemas.values().forEach(schema -> postProcessSchema(schema, actualContentType));
108+
preProcessSchemas(newSchemas, schemaName, type);
109+
newSchemas.forEach(this.schemas::putIfAbsent);
110+
newSchemas.values().forEach(schema -> postProcessSchema(schema, actualContentType));
100111

101112
return schemaName;
102113
}
@@ -130,11 +141,40 @@ private String getSchemaName(Class<?> type, Map<String, Schema> schemas) {
130141
return new ArrayList<>(resolvedPayloadModelName).get(0);
131142
}
132143

133-
return type.getSimpleName();
144+
return getNameFromClass(type);
134145
}
135146

136147
private void preProcessSchemas(Map<String, Schema> schemas, String schemaName, Class<?> type) {
148+
processCommonModelConverters(schemas);
137149
processAsyncApiPayloadAnnotation(schemas, schemaName, type);
150+
processSchemaAnnotation(schemas, schemaName, type);
151+
}
152+
153+
private void processCommonModelConverters(Map<String, Schema> schemas) {
154+
schemas.values().stream()
155+
.filter(schema -> schema.getType() == null)
156+
.filter(schema -> schema.get$ref() != null)
157+
.forEach(schema -> {
158+
String targetSchemaName = schema.getName();
159+
String sourceSchemaName = StringUtils.substringAfterLast(schema.get$ref(), "/");
160+
161+
Schema<?> actualSchema = schemas.get(sourceSchemaName);
162+
163+
if (actualSchema != null) {
164+
schemas.put(targetSchemaName, actualSchema);
165+
schemas.remove(sourceSchemaName);
166+
}
167+
});
168+
}
169+
170+
private void processSchemaAnnotation(Map<String, Schema> schemas, String schemaName, Class<?> type) {
171+
Schema schemaForType = schemas.get(schemaName);
172+
if (schemaForType != null) {
173+
var schemaAnnotation = type.getAnnotation(io.swagger.v3.oas.annotations.media.Schema.class);
174+
if (schemaAnnotation != null) {
175+
schemaForType.setDescription(schemaAnnotation.description());
176+
}
177+
}
138178
}
139179

140180
private void processAsyncApiPayloadAnnotation(Map<String, Schema> schemas, String schemaName, Class<?> type) {
@@ -161,9 +201,9 @@ private void processAsyncApiPayloadAnnotation(Map<String, Schema> schemas, Strin
161201
}
162202

163203
private String registerString() {
164-
String schemaName = "String";
204+
String schemaName = getNameFromClass(String.class);
165205
StringSchema schema = new StringSchema();
166-
schema.setName(String.class.getName());
206+
schema.setName(schemaName);
167207

168208
this.schemas.put(schemaName, schema);
169209
postProcessSchema(schema, DEFAULT_CONTENT_TYPE);
@@ -181,6 +221,13 @@ private <R> R runWithFqnSetting(Function<Void, R> callable) {
181221
return result;
182222
}
183223

224+
private String getNameFromClass(Class<?> type) {
225+
if (properties.isUseFqn()) {
226+
return type.getName();
227+
}
228+
return type.getSimpleName();
229+
}
230+
184231
private void postProcessSchema(Schema schema, String contentType) {
185232
for (SchemasPostProcessor processor : schemaPostProcessors) {
186233
processor.process(schema, schemas, contentType);

‎springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/headers/AsyncHeadersBuilder.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22
package io.github.springwolf.core.asyncapi.components.headers;
33

44
import io.github.springwolf.asyncapi.v3.model.schema.SchemaObject;
5+
import io.github.springwolf.core.asyncapi.scanners.common.payload.NamedSchemaObject;
56

67
public interface AsyncHeadersBuilder {
7-
SchemaObject buildHeaders(Class<?> payloadType);
8+
SchemaObject buildHeaders(NamedSchemaObject payloadSchema);
89
}

‎springwolf-core/src/main/java/io/github/springwolf/core/asyncapi/components/headers/AsyncHeadersNotDocumented.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
package io.github.springwolf.core.asyncapi.components.headers;
33

44
import io.github.springwolf.asyncapi.v3.model.schema.SchemaObject;
5+
import io.github.springwolf.core.asyncapi.scanners.common.payload.NamedSchemaObject;
56

67
import java.util.List;
78
import java.util.Map;
@@ -22,7 +23,7 @@ public class AsyncHeadersNotDocumented implements AsyncHeadersBuilder {
2223
}
2324

2425
@Override
25-
public SchemaObject buildHeaders(Class<?> payloadType) {
26+
public SchemaObject buildHeaders(NamedSchemaObject payloadSchema) {
2627
return NOT_DOCUMENTED;
2728
}
2829
}

0 commit comments

Comments
 (0)