Load resources from dependency jar file in plugin

Help/Discuss
1

Hello,
I’d like to contribute one feature to openapi-generator-gradle-plugin however I’m not sure if that’s possible in gradle.

For a reference in maven plugin it works like this: you can add dependency for plugin (e.g. some library which contains openapi.yaml somewhere in resources) and load files directly from that dependency.

I’d like to do the same, however I’m not sure if I’m able to access/configure the classpath/dependencies for that particular plugin. I’ve seen that there is an option in plugin configuration to include dependencies but IDK what else to check.

Any ideas are welcome.

Thanks

2

If you want to contribute a feature to that plugin, you should head to the maintainer of that plugin.

But if I understood correctly what you intend, then this is probably already possible with standard Gradle and the plugin as-is.
I just cannot tell you exactly how, as your situation is not clear enough for me.
Maybe if you knit an MCVE.

3

@Vampire MCVE here. If you execute openapiGenerate you will see that currently it’s not possible to resolve openapi definition from a classpath. I’d like to do the same as within maven plugin

currently the openapi file should be resolved from project some-api but anyway it should be possible to load it also from a jar file

4 
diff --git a/some-client/build.gradle.kts b/some-client/build.gradle.kts
index 5ee5d7e..59af15a 100644
--- a/some-client/build.gradle.kts
+++ b/some-client/build.gradle.kts
@@ -7,8 +7,15 @@ plugins {
     id("org.openapi.generator") version "7.12.0"
 }

+val specDependency = configurations.dependencyScope("specDependency")
+val spec = configurations.resolvable("spec") {
+    extendsFrom(specDependency.get())
+    isTransitive = false
+}
+
 dependencies {
     api(project(":some-api"))
+    specDependency(project(":some-api"))
 }

 val openapiBasePackage = "com.github.bilak.app.generated"
@@ -28,9 +35,14 @@ openApiGenerate {
     ))
     generateApiTests.set(false)
     generatorName.set("spring")
-    //inputSpec.set("$projectDir/src/main/resources/openapi/openapi.yaml")
-    // TODO this should be the path from *.jar file src/resources
-    inputSpec.set("openapi/someapi/openapi.yaml")
+    val resources = resources
+    inputSpec.set(
+        spec
+            .flatMap { it.elements }
+            .map {
+                resources.text.fromArchiveEntry(it, "openapi/someapi/openapi.yaml").asFile().absolutePath
+            }
+    )
     invokerPackage.set("$openapiBasePackage.invoker")
     modelNameSuffix.set("DTO")
     modelPackage.set("$openapiBasePackage.model")
5

Thanks a lot!!!
I’ve seen that this is some kind of incubating api (at least intellij told me so)..is there any plan when it gets into stable?

6

No idea, if you are concerned about that, you can also use the traditional

val specDependency by configurations.registering {
    isCanBeConsumed = false
    isCanBeResolved = false
}
val spec by configurations.registering {
    extendsFrom(specDependency.get())
    isCanBeConsumed = false
    isCanBeResolved = true
    isTransitive = false
}

Those are just convenience helpers.