Question: Multi-project setup, and additional settings

[perracodex]

Does this library support to project setup? If so, then where would it go the concrete configuration? in the subprojects Gradle block?
In addition, is it possible to set the servers, security credentials, and swager url at runtime?
Thanks

[tabilzad]

It depends on the kind on multi project. If there is a main module containing the server definition itself along with all of the routes/endpoints while other modules only provide the data schemas - then yes the plugin would support that kind of setup and you would only need to apply the plugin to the main module. However, if the route definitions are distributed across multiple modules then each would need the plugin applied and therefore would get a separate openapi.yaml generated. Aggregation of the generated docs from this kind of multi-module setup will come in later releases.

Regarding the runtime configuration: The plugin is invoked at build time, and so the openapi.yaml is generated before the app starts, however there is nothing preventing you from modifying the file at runtime before serving.
The servers can already be configured in the gradle config starting from 0.6.3. Credentials support is on the roadmap but priority for now is generating a comprehensive documentation that can be exported in CI rather than being served at runtime in the same server environment.

[schott12521]

In addition, is it possible to set the servers, security credentials, and swager url at runtime?

compileTime but yes, its possible to set via the gradle plugin settings now:

swagger {

    documentation {
        info {
            title = "Example Service API"
            description = "Documentation for using the Example Service"
            version = project.version.toString()
        }

        security {
            scopes {
                or {
                    +"auth-jwt"
                    "auth-basic" to listOf("scopes"
                }
            }

            schemes {
                "auth-jwt" to SecurityScheme(
                    type = "http",
                    scheme = "bearer",
                    description = "This is used for user authentication"
                )

                "auth-basic" to SecurityScheme(
                    type = "http",
                    scheme = "basic",
                    description = "This is ONLY used for server-to-server communication"
                )
            }
        }
        ...
        servers = listOf("serverStrings)
    }

    pluginOptions {
        ...
    }
}

There's still work pending to support route-based security configuration, but that will come.