Skip to content

Commit

Permalink
Add ability to disable micronaut-openapi
Browse files Browse the repository at this point in the history 
Fixed #977
  • Loading branch information
@altro3
altro3 committed Apr 5, 2023
1 parent 15334de commit 3599d25
Show file tree
Hide file tree
Showing 9 changed files with 153 additions and 27 deletions.
6 changes: 6 additions & 0 deletions openapi/src/main/java/io/micronaut/openapi/visitor/AbstractOpenApiEndpointVisitor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,9 @@ private static RequestBody mergeRequestBody(RequestBody rq1, RequestBody rq2) {
* @param context The visitor context
*/
public void visitClass(ClassElement element, VisitorContext context) {
if (!Utils.isOpenApiEnabled()) {
return;
}
if (ignore(element, context)) {
return;
}
Expand Down Expand Up @@ -359,6 +362,9 @@ private boolean hasNoBindingAnnotationOrType(TypedElement parameter) {
* @param context The visitor context
*/
public void visitMethod(MethodElement element, VisitorContext context) {
if (!Utils.isOpenApiEnabled()) {
return;
}
if (ignore(element, context)) {
return;
}
Expand Down
1 change: 1 addition & 0 deletions openapi/src/main/java/io/micronaut/openapi/visitor/ConvertUtils.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -199,6 +199,7 @@ public static SecurityRequirement mapToSecurityRequirement(AnnotationValue<io.sw
/**
* Detect openapi type and format for enums.
*
* @param context visitor context
* @param type enum element
* @param schemaType type from swagger Schema annotation
* @param schemaFormat format from swagger Schema annotation
Expand Down
55 changes: 34 additions & 21 deletions openapi/src/main/java/io/micronaut/openapi/visitor/OpenApiApplicationVisitor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,7 @@
* @since 1.0
*/
@SupportedOptions({
OpenApiApplicationVisitor.MICRONAUT_OPENAPI_ENABLED,
OpenApiApplicationVisitor.MICRONAUT_OPENAPI_CONTEXT_SERVER_PATH,
OpenApiApplicationVisitor.MICRONAUT_OPENAPI_PROPERTY_NAMING_STRATEGY,
OpenApiApplicationVisitor.MICRONAUT_OPENAPI_VIEWS_SPEC,
Expand All @@ -111,6 +112,12 @@
})
public class OpenApiApplicationVisitor extends AbstractOpenApiVisitor implements TypeElementVisitor<OpenAPIDefinition, Object> {

/**
* System property that enables or disables open api annotation processing.
* <br>
* Default: true
*/
public static final String MICRONAUT_OPENAPI_ENABLED = "micronaut.openapi.enabled";
/**
* System property that enables setting the open api config file.
*/
Expand Down Expand Up @@ -266,6 +273,9 @@ public class OpenApiApplicationVisitor extends AbstractOpenApiVisitor implements

@Override
public void visitClass(ClassElement element, VisitorContext context) {
if (!Utils.isOpenApiEnabled()) {
return;
}
incrementVisitedElements(context);
context.info("Generating OpenAPI Documentation");
OpenAPI openAPI = readOpenAPI(element, context);
Expand Down Expand Up @@ -965,20 +975,23 @@ private static OpenAPI resolvePropertyPlaceHolders(OpenAPI openAPI, VisitorConte
}

@Override
public void finish(VisitorContext visitorContext) {
if (visitedElements == visitedElements(visitorContext)) {
public void finish(VisitorContext context) {
if (!Utils.isOpenApiEnabled()) {
return;
}
if (visitedElements == visitedElements(context)) {
// nothing new visited, avoid rewriting the files.
return;
}
Optional<OpenAPI> attr = visitorContext.get(Utils.ATTR_OPENAPI, OpenAPI.class);
Optional<OpenAPI> attr = context.get(Utils.ATTR_OPENAPI, OpenAPI.class);
if (!attr.isPresent()) {
return;
}
OpenAPI openAPI = attr.get();
processEndpoints(visitorContext);
applyPropertyNamingStrategy(openAPI, visitorContext);
applyPropertyServerContextPath(openAPI, visitorContext);
openAPI = resolvePropertyPlaceHolders(openAPI, visitorContext);
processEndpoints(context);
applyPropertyNamingStrategy(openAPI, context);
applyPropertyServerContextPath(openAPI, context);
openAPI = resolvePropertyPlaceHolders(openAPI, context);
sortOpenAPI(openAPI);
// Process after sorting so order is stable
new JacksonDiscriminatorPostProcessor().addMissingDiscriminatorType(openAPI);
Expand Down Expand Up @@ -1009,7 +1022,7 @@ public void finish(VisitorContext visitorContext) {

removeEmtpyComponents(openAPI);

String isJson = getConfigurationProperty(MICRONAUT_OPENAPI_JSON_FORMAT, visitorContext);
String isJson = getConfigurationProperty(MICRONAUT_OPENAPI_JSON_FORMAT, context);
boolean isYaml = !(StringUtils.isNotEmpty(isJson) && isJson.equalsIgnoreCase(StringUtils.TRUE));

String ext = isYaml ? EXT_YML : EXT_JSON;
Expand All @@ -1026,19 +1039,19 @@ public void finish(VisitorContext visitorContext) {
}
fileName = documentTitle + ext;
}
String fileNameFromConfig = getConfigurationProperty(MICRONAUT_OPENAPI_FILENAME, visitorContext);
String fileNameFromConfig = getConfigurationProperty(MICRONAUT_OPENAPI_FILENAME, context);
if (StringUtils.isNotEmpty(fileNameFromConfig)) {
fileName = replacePlaceholders(fileNameFromConfig, visitorContext) + ext;
fileName = replacePlaceholders(fileNameFromConfig, context) + ext;
if (fileName.contains("${version}")) {
fileName = fileName.replaceAll("\\$\\{version}", info != null && info.getVersion() != null ? info.getVersion() : StringUtils.EMPTY_STRING);
}
if (fileName.contains("${")) {
visitorContext.warn("Can't set some placeholders in fileName: " + fileName, null);
context.warn("Can't set some placeholders in fileName: " + fileName, null);
}
}

writeYamlToFile(openAPI, fileName, documentTitle, visitorContext, isYaml);
visitedElements = visitedElements(visitorContext);
writeYamlToFile(openAPI, fileName, documentTitle, context, isYaml);
visitedElements = visitedElements(context);
}

private void removeEmtpyComponents(OpenAPI openAPI) {
Expand Down Expand Up @@ -1168,24 +1181,24 @@ private Writer getFileWriter(Optional<Path> specFile) throws IOException {
}
}

private void processEndpoints(VisitorContext visitorContext) {
EndpointsConfiguration endpointsCfg = endPointsConfiguration(visitorContext);
private void processEndpoints(VisitorContext context) {
EndpointsConfiguration endpointsCfg = endPointsConfiguration(context);
if (endpointsCfg.isEnabled() && !endpointsCfg.getEndpoints().isEmpty()) {
OpenApiEndpointVisitor visitor = new OpenApiEndpointVisitor(true);
endpointsCfg.getEndpoints().values().stream()
.filter(endpoint -> endpoint.getClassElement().isPresent())
.forEach(endpoint -> {
ClassElement element = endpoint.getClassElement().get();
visitorContext.put(MICRONAUT_OPENAPI_ENDPOINT_CLASS_TAGS, endpoint.getTags());
visitorContext.put(MICRONAUT_OPENAPI_ENDPOINT_SERVERS, endpoint.getServers());
visitorContext.put(MICRONAUT_OPENAPI_ENDPOINT_SECURITY_REQUIREMENTS, endpoint.getSecurityRequirements());
visitor.visitClass(element, visitorContext);
context.put(MICRONAUT_OPENAPI_ENDPOINT_CLASS_TAGS, endpoint.getTags());
context.put(MICRONAUT_OPENAPI_ENDPOINT_SERVERS, endpoint.getServers());
context.put(MICRONAUT_OPENAPI_ENDPOINT_SECURITY_REQUIREMENTS, endpoint.getSecurityRequirements());
visitor.visitClass(element, context);
element.getEnclosedElements(ElementQuery.ALL_METHODS
.modifiers(mods -> !mods.contains(ElementModifier.STATIC) && !mods.contains(ElementModifier.PRIVATE))
.named(name -> !name.contains("$"))
)
.forEach(method -> visitor.visitMethod(method, visitorContext));
});
.forEach(method -> visitor.visitMethod(method, context));
});
}
}

Expand Down
4 changes: 4 additions & 0 deletions openapi/src/main/java/io/micronaut/openapi/visitor/OpenApiControllerVisitor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@
import java.util.Set;
import java.util.stream.Collectors;

import javax.annotation.processing.SupportedOptions;

import io.micronaut.context.RequiresCondition;
import io.micronaut.context.annotation.Requires;
import io.micronaut.context.env.Environment;
Expand Down Expand Up @@ -53,6 +55,7 @@

import com.fasterxml.jackson.annotation.JsonAnySetter;

import static io.micronaut.openapi.visitor.OpenApiApplicationVisitor.MICRONAUT_OPENAPI_ENABLED;
import static io.micronaut.openapi.visitor.Utils.DEFAULT_MEDIA_TYPES;

/**
Expand All @@ -61,6 +64,7 @@
* @author graemerocher
* @since 1.0
*/
@SupportedOptions(MICRONAUT_OPENAPI_ENABLED)
public class OpenApiControllerVisitor extends AbstractOpenApiEndpointVisitor implements TypeElementVisitor<Object, HttpMethodMapping> {

private final String customUri;
Expand Down
7 changes: 7 additions & 0 deletions openapi/src/main/java/io/micronaut/openapi/visitor/OpenApiEndpointVisitor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@
import java.util.List;
import java.util.stream.Collectors;

import javax.annotation.processing.SupportedOptions;

import io.micronaut.core.annotation.AnnotationValue;
import io.micronaut.core.naming.NameUtils;
import io.micronaut.core.util.ArrayUtils;
Expand All @@ -40,6 +42,7 @@

import com.fasterxml.jackson.annotation.JsonAnySetter;

import static io.micronaut.openapi.visitor.OpenApiApplicationVisitor.MICRONAUT_OPENAPI_ENABLED;
import static io.micronaut.openapi.visitor.Utils.DEFAULT_MEDIA_TYPES;

/**
Expand All @@ -49,6 +52,7 @@
* @author croudet
* @since 1.4
*/
@SupportedOptions(MICRONAUT_OPENAPI_ENABLED)
public class OpenApiEndpointVisitor extends AbstractOpenApiEndpointVisitor implements TypeElementVisitor<Object, Object> {

private String id;
Expand Down Expand Up @@ -80,6 +84,9 @@ public OpenApiEndpointVisitor(boolean enabled,

@Override
public void visitClass(ClassElement element, VisitorContext context) {
if (!Utils.isOpenApiEnabled()) {
return;
}
EndpointsConfiguration cfg = OpenApiApplicationVisitor.endPointsConfiguration(context);
if (enabled == null) {
enabled = cfg.isEnabled();
Expand Down
16 changes: 12 additions & 4 deletions openapi/src/main/java/io/micronaut/openapi/visitor/OpenApiIncludeVisitor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
import java.util.List;
import java.util.Optional;

import javax.annotation.processing.SupportedOptions;

import io.micronaut.core.annotation.AnnotationValue;
import io.micronaut.core.util.ArrayUtils;
import io.micronaut.http.annotation.Controller;
Expand All @@ -31,15 +33,21 @@
import io.swagger.v3.oas.annotations.security.SecurityRequirement;
import io.swagger.v3.oas.annotations.tags.Tag;

import static io.micronaut.openapi.visitor.OpenApiApplicationVisitor.MICRONAUT_OPENAPI_ENABLED;

/**
* A {@link TypeElementVisitor} that builds the Swagger model from Micronaut controllers included by @{@link OpenAPIInclude} at the compile time.
*
* @author Denis Stepanov
*/
@SupportedOptions(MICRONAUT_OPENAPI_ENABLED)
public class OpenApiIncludeVisitor implements TypeElementVisitor<OpenAPIIncludes, Object> {

@Override
public void visitClass(ClassElement element, VisitorContext visitorContext) {
public void visitClass(ClassElement element, VisitorContext context) {
if (!Utils.isOpenApiEnabled()) {
return;
}
for (AnnotationValue<OpenAPIInclude> includeAnnotation : element.getAnnotationValuesByType(OpenAPIInclude.class)) {
String[] classes = includeAnnotation.stringValues();
if (ArrayUtils.isNotEmpty(classes)) {
Expand All @@ -50,12 +58,12 @@ public void visitClass(ClassElement element, VisitorContext visitorContext) {
OpenApiControllerVisitor controllerVisitor = new OpenApiControllerVisitor(tags, security, customUri.orElse(null));
OpenApiEndpointVisitor endpointVisitor = new OpenApiEndpointVisitor(true, tags.isEmpty() ? null : tags, security.isEmpty() ? null : security);
for (String className : classes) {
visitorContext.getClassElement(className)
context.getClassElement(className)
.ifPresent(ce -> {
if (ce.isAnnotationPresent(Controller.class)) {
visit(controllerVisitor, visitorContext, ce);
visit(controllerVisitor, context, ce);
} else if (ce.isAnnotationPresent("io.micronaut.management.endpoint.annotation.Endpoint")) {
visit(endpointVisitor, visitorContext, ce);
visit(endpointVisitor, context, ce);
}
});
}
Expand Down
10 changes: 9 additions & 1 deletion openapi/src/main/java/io/micronaut/openapi/visitor/OpenApiJacksonVisitor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@
import java.util.List;
import java.util.Set;

import javax.annotation.processing.SupportedOptions;

import io.micronaut.core.annotation.AnnotationClassValue;
import io.micronaut.core.annotation.AnnotationValue;
import io.micronaut.core.annotation.NonNull;
Expand All @@ -33,13 +35,16 @@
import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;

import static io.micronaut.openapi.visitor.OpenApiApplicationVisitor.MICRONAUT_OPENAPI_ENABLED;

/**
* A {@link TypeElementVisitor} that builds appropriate {@link Schema} annotation for the parent class of a hierarchy
* when using Jackson {@link JsonTypeInfo} and {@link JsonSubTypes}.
*
* @author Iván López
* @since 3.0.0
*/
@SupportedOptions(MICRONAUT_OPENAPI_ENABLED)
public class OpenApiJacksonVisitor implements TypeElementVisitor<Object, Object> {

@Override
Expand All @@ -62,7 +67,10 @@ public int getOrder() {
}

@Override
public void visitClass(ClassElement element, VisitorContext visitorContext) {
public void visitClass(ClassElement element, VisitorContext context) {
if (!Utils.isOpenApiEnabled()) {
return;
}
AnnotationValue<JsonSubTypes> jsonSubTypesDecAnn = element.getDeclaredAnnotation(JsonSubTypes.class);
AnnotationValue<JsonTypeInfo> jsonTypeInfoDecAnn = element.getDeclaredAnnotation(JsonTypeInfo.class);
AnnotationValue<Schema> schemaAnn = element.getDeclaredAnnotation(Schema.class);
Expand Down
10 changes: 9 additions & 1 deletion openapi/src/main/java/io/micronaut/openapi/visitor/Utils.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
import io.micronaut.core.convert.ArgumentConversionContext;
import io.micronaut.core.convert.DefaultConversionService;
import io.micronaut.core.util.CollectionUtils;
import io.micronaut.core.util.StringUtils;
import io.micronaut.core.value.PropertyResolver;
import io.micronaut.http.MediaType;
import io.micronaut.inject.ast.ClassElement;
Expand All @@ -40,6 +41,8 @@
import io.swagger.v3.oas.models.Components;
import io.swagger.v3.oas.models.OpenAPI;

import static io.micronaut.openapi.visitor.OpenApiApplicationVisitor.MICRONAUT_OPENAPI_ENABLED;

/**
* Some util methods.
*
Expand Down Expand Up @@ -68,12 +71,17 @@ public final class Utils {
private Utils() {
}

public static boolean isOpenApiEnabled() {
String isEnabledStr = System.getProperty(MICRONAUT_OPENAPI_ENABLED, StringUtils.TRUE);
return !StringUtils.isNotEmpty(isEnabledStr) || !isEnabledStr.equalsIgnoreCase(StringUtils.FALSE);
}

public static Path getProjectPath(VisitorContext context) {
return context.getProjectDir().orElse(Utils.isTestMode() ? Paths.get(System.getProperty("user.dir")) : null);
}

/**
* @return An Instance of sdefault {@link PropertyPlaceholderResolver} to resolve placeholders.
* @return An Instance of default {@link PropertyPlaceholderResolver} to resolve placeholders.
*/
public static PropertyPlaceholderResolver getPropertyPlaceholderResolver() {
if (propertyPlaceholderResolver == null) {
Expand Down
Loading

0 comments on commit 3599d25

Please sign in to comment.