Another thing I just ran into and I am not sure on how to specify, what if my endpoint

use the throws route selector: <div class="highlight highlight-source-kotlin notra

<a class="user-mention notranslate" data-hovercard-type="user" data-hovercard-url="/us

Multiple responses about ktor-openapi-generator HOT 4 CLOSED

Globegitter commented on May 18, 2024

Multiple responses

from ktor-openapi-generator.

Comments (4)

Wicpar commented on May 18, 2024 1

@Request and @Response only work on the reified type you declare, subclasses are not analyzed, and at runtime no reflection occurs.

from ktor-openapi-generator.

Wicpar commented on May 18, 2024

use the throws route selector:

                throws(APIException.apiException(HttpStatusCode.BadRequest) {it: Exception -> 
                    ExceptionDescriptionDTO(it)
                }) {
                    ...
                }

this will catch and respond the exception, and create the appropriate descriptions.

you can also declare them globally if you use the ktor status pages:

            val api = install(OpenAPIGen)  { ... }
...
            // StatusPage interop, can also define exceptions per-route
            install(StatusPages) {
                withAPI(api) {
                    exception<JsonMappingException, Error>(HttpStatusCode.BadRequest) {
                        it.printStackTrace()
                        Error("mapping.json", it.localizedMessage)
                    }
                    exception<ProperException, Error>(HttpStatusCode.BadRequest) {
                        it.printStackTrace()
                        Error(it.id, it.localizedMessage)
                    }
                }
            }

from ktor-openapi-generator.

Globegitter commented on May 18, 2024

Ah cool, thanks for the examples. The first thing that came to my mind and I tried was again using sealed classes so e.g. having

sealed class MyResponses

@Response("An NotFound error response", 404)
data class NotFoundResponse(val message: String): MyResponses()

@Response("Response when request was a success", 201)
object Created: MyResponses()

but this has some drawbacks in itself and what you just posted is more than sufficient for now thanks.

from ktor-openapi-generator.

Globegitter commented on May 18, 2024

@Wicpar One more question - how can I provide examples for the error responses in the StatusPages integration?

from ktor-openapi-generator.

Recommend Projects