bkbnio / kompendium

Ktor OpenAPI Spec Generator
https://bkbn.gitbook.io/kompendium
MIT License
151 stars 22 forks source link

Save to file system or application resources #615

Closed oSumAtrIX closed 3 months ago

oSumAtrIX commented 3 months ago

The Ktor plugin "Swagger UI" notes:

This method tries to look up the OpenAPI specification in the application resources. Otherwise, it tries to read the OpenAPI specification from the file system using java.io.File.

Unless Kompendium saves the specification to the file system or application resources, there is no way to use the Swagger UI plugin for Ktor.

brizzbuzz commented 3 months ago

i'm not familiar with this plugin, is there a specific advantage over just using the kompendium helper route that serves swagger ui?

anderssonw commented 3 months ago

I didn't realise Kompendium offered its own helper route that serves the swagger ui at first, this might be the case here as well

Both OpenAPI and Swagger KTor plugins expect a file at startup (AFAIK), whereas kompendium does it runtime, so I don't really think they're compatible frameworks