Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Question: Multi-project setup, and additional settings #24

Open
perracodex opened this issue Sep 15, 2024 · 1 comment
Open

Question: Multi-project setup, and additional settings #24

perracodex opened this issue Sep 15, 2024 · 1 comment

Comments

@perracodex
Copy link

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
Copy link
Owner

tabilzad commented Oct 3, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants