Add ability to set project directory.

Fixed #1101

gradle/libs.versions.toml

@@ -9,7 +9,7 @@ managed-jakarta-validation-api = "3.0.2"
 # Versions beyond 0.62.2 require Java 11
 managed-html2md-converter = "0.62.2"
 
-kotlin = "1.9.0"
+kotlin = "1.8.22"
 kotlin-coroutines = "1.7.2"
 jspecify = "0.3.0"
 jdt-annotation = "2.2.700"

openapi/src/main/java/io/micronaut/openapi/visitor/OpenApiApplicationVisitor.java

@@ -134,6 +134,7 @@
     OpenApiApplicationVisitor.MICRONAUT_OPENAPI_CONFIG_FILE,
     OpenApiApplicationVisitor.MICRONAUT_OPENAPI_SECURITY_ENABLED,
     OpenApiApplicationVisitor.MICRONAUT_OPENAPI_VERSIONING_ENABLED,
+    OpenApiApplicationVisitor.MICRONAUT_OPENAPI_PROJECT_DIR,
 })
 public class OpenApiApplicationVisitor extends AbstractOpenApiVisitor implements TypeElementVisitor<OpenAPIDefinition, Object> {
 
@@ -175,6 +176,14 @@ public class OpenApiApplicationVisitor extends AbstractOpenApiVisitor implements
      * System property that specifies the location of additional swagger YAML and JSON files to read from.
      */
     public static final String MICRONAUT_OPENAPI_ADDITIONAL_FILES = "micronaut.openapi.additional.files";
+    /**
+     * System property that specifies the location of current project.
+     */
+    public static final String MICRONAUT_OPENAPI_PROJECT_DIR = "micronaut.openapi.project.dir";
+    /**
+     * Loaded project directory from system properties.
+     */
+    public static final String MICRONAUT_INTERNAL_OPENAPI_PROJECT_DIR = "micronaut.internal.openapi.project.dir";
     /**
      * System property that specifies the default security schema name, if it's not specified by annotation SecurityScheme.
      */

openapi/src/main/java/io/micronaut/openapi/visitor/Utils.java

@@ -42,6 +42,9 @@
 import io.swagger.v3.oas.models.Components;
 import io.swagger.v3.oas.models.OpenAPI;
 
+import static io.micronaut.openapi.visitor.OpenApiApplicationVisitor.MICRONAUT_INTERNAL_OPENAPI_PROJECT_DIR;
+import static io.micronaut.openapi.visitor.OpenApiApplicationVisitor.MICRONAUT_OPENAPI_PROJECT_DIR;
+
 /**
  * Some util methods.
  *
@@ -92,14 +95,28 @@ private Utils() {
 
     @Nullable
     public static Path getProjectPath(VisitorContext context) {
-        Path path;
-        try {
-            path = context.getProjectDir().orElse(Utils.isTestMode() ? Paths.get(System.getProperty("user.dir")) : null);
-        } catch (Exception e) {
-            // Should never happen
-            path = Paths.get(System.getProperty("user.dir"));
+
+        Path projectPath = context.get(MICRONAUT_INTERNAL_OPENAPI_PROJECT_DIR, Path.class).orElse(null);
+        if (projectPath != null) {
+            return projectPath;
+        }
+
+        String projectDir = System.getProperty(MICRONAUT_OPENAPI_PROJECT_DIR);
+        if (projectDir != null) {
+            projectPath = Paths.get(projectDir);
         }
-        return path;
+        if (projectPath == null) {
+            try {
+                projectPath = context.getProjectDir().orElse(Utils.isTestMode() ? Paths.get(System.getProperty("user.dir")) : null);
+            } catch (Exception e) {
+                // Should never happen
+                projectPath = Paths.get(System.getProperty("user.dir"));
+            }
+        }
+
+        context.put(MICRONAUT_INTERNAL_OPENAPI_PROJECT_DIR, projectPath);
+
+        return projectPath;
     }
 
     /**

src/main/docs/guide/customSerializers.adoc

@@ -1,6 +1,6 @@
 You can set custom classes to create different open api schemas for selected classes:
 
-[source,yaml]
+[configuration]
 ----
 micronaut:
   openapi:
@@ -77,7 +77,7 @@ class MyJaxbElement3 {
 
 And set openapi properties to map classes to custom openapi schema classes:
 
-[source,yaml]
+[configuration]
 ----
 micronaut:
   openapi:

src/main/docs/guide/exposingSwaggerOutput.adoc

@@ -1,14 +1,14 @@
 If you wish to expose the generated OpenAPI yaml output from your running application you can simply add the necessary static resource to the application configuration. For example:
 
 .Exposing OpenAPI YAML
-[source,yaml]
+[configuration]
 ----
 micronaut:
-    router:
-        static-resources:
-            swagger:
-                paths: classpath:META-INF/swagger
-                mapping: /swagger/**
+  router:
+    static-resources:
+      swagger:
+        paths: classpath:META-INF/swagger
+        mapping: /swagger/**
 ----
 
 With the above configuration in place when you run your application you can access your Swagger documentation at `http://localhost:8080/swagger/hello-world-0.0.yml`.

src/main/docs/guide/openApiViews/mappingPath.adoc

@@ -5,7 +5,7 @@ Thus, by default, the views expect to find the `yaml` under `/swagger`.
 If you change this mapping to something else:
 
 .Exposing Swagger YAML
-[source,yaml]
+[configuration]
 ----
 micronaut:
   router:

src/main/docs/guide/openApiViews/rapidoc.adoc

@@ -52,7 +52,7 @@ See https://mrin9.github.io/RapiDoc/api.html[RapiDoc Options] for a description.
 To expose the `rapidoc` views, you also must expose the generated `yaml`:
 
 .Exposing Swagger YAML And Rapidoc Views
-[source,yaml]
+[configuration]
 ----
 micronaut:
   router:

src/main/docs/guide/openApiViews/redoc.adoc

@@ -36,7 +36,7 @@ See https://github.com/Redocly/redoc#redoc-options-object[Redoc Options] for a d
 To expose the `redoc` views, you also must expose the generated `yaml`:
 
 .Exposing Swagger YAML And Redoc Views
-[source,yaml]
+[configuration]
 ----
 micronaut:
   router:

src/main/docs/guide/openApiViews/swaggerui.adoc

@@ -36,7 +36,7 @@ See https://github.com/swagger-api/swagger-ui/blob/HEAD/docs/usage/configuration
 To expose the `swagger-ui` views, you also must expose the generated `yaml`:
 
 .Exposing Swagger YAML and Swagger UI Views
-[source,yaml]
+[configuration]
 ----
 micronaut:
   router:

src/main/docs/guide/openApiViews/swaggerui/oauth2.adoc

@@ -83,7 +83,7 @@ public class OrderController {
 
 Do not forget to configure Micronaut Security accordingly:
 
-[source,yaml]
+[configuration]
 ----
 micronaut:
   security:

src/main/docs/guide/schemaDecorators.adoc

@@ -1,6 +1,6 @@
 If you have some classes with same names in different packages you can set postfix like this:
 
-[source,yaml]
+[configuration]
 ----
 micronaut:
   openapi:

src/main/docs/guide/versionsAndGroups/groups.adoc

@@ -28,7 +28,7 @@ public class ApiController {
 }
 ----
 
-[source,yaml]
+[configuration]
 ----
 micronaut:
   openapi:

src/main/docs/guide/versionsAndGroups/versions.adoc

@@ -40,7 +40,7 @@ public class VersionedController {
 ----
 
 .application.yml
-[source,yaml]
+[configuration]
 ----
 micronaut:
   router: