search

springdoc / springdoc.github.io

Library for OpenAPI 3 with spring-boot
https://springdoc.org
Apache License 2.0
9 stars 42 forks source link

Kotlin module for v2? #41

Closed bkielczewski closed 1 year ago

bkielczewski commented 1 year ago

In v2.0.0 there seems to be no Kotlin module, yet the doc mentions otherwise. Latest on Maven Central is 1.6.13.

bnasslahsen commented 1 year ago

@bkielczewski,

Please Read: https://springdoc.org/v2/#migrating-from-springdoc-v1 Or https://springdoc.org/v2/#kotlin-support

bkielczewski commented 1 year ago

Ok, thanks, but https://springdoc.org/v2/#kotlin-support bit is confusing.

This bit exactly (my use case):

If you are using spring-webflux, you should combine the springdoc-openapi-kotlin module with springdoc-openapi-starter-webflux-ui.

bkielczewski commented 1 year ago

Also, springdoc-openapi-starter-common seems to be a dependency of springdoc-openapi-starter-webflux-ui, so that should be ok for Kotlin support. However, when I'm using suspend function on rest endpoint I get documentation for $completion parameter there. Should I file a bug report for regression (wasn't like that in v1)?

bnasslahsen commented 1 year ago

@bkielczewski,

I understand that your point is related to documentation. I have updated it.

For the supend issue report, you can see for example this test: https://github.com/springdoc/springdoc-openapi/blob/2.x/springdoc-openapi-tests/springdoc-openapi-kotlin-tests/src/test/kotlin/test/org/springdoc/api/app3/SystemStatusController.kt

The openAPI spec is generated just correctly.

If you want to report an issue, just make sure you provide a Minimal, Reproducible Example - with HelloController that reproduces the problem