bnorm / ktor-retrofit

Turns a Retrofit service interface into Ktor routing

I do the clickety-clackety that make the computer go brrr

ktor-retrofit's Issues

Support Response<T> return type serialization in APIServices

I use Response wrapped response structure everywhere in my services (for error handling) so it looks like:

interface Service {
  @GET("string")
  suspend fun getAll(): Response<List<String>>

  @GET("string/{id}")
  suspend fun getSingle(@Path("id") id: Long): Response<String>
}

And then in the ktor-retrofit service implementation, I then return a

return Response.success(myResponseObj)

But for some reason, my responses are not transmitted if implemented this way, here's a snippet of the response when hitting a ktor-retrofit implemented endpoint (logged via HttpLoggingInterceptor):

Vary: Origin
Content-Type: application/json; charset=UTF-8
Connection: keep-alive
transfer-encoding: chunked

{}
<-- END HTTP (2-byte body)

Notice the empty {}

The service is installed as:

  routing {
        route("/") {
            authenticate(AuthLabel) {
                retrofitService(service = MyService)
            }

Protect against service interfaces with conflicting endpoints

The behavior of multiple functions in a service mapping to the same endpoint is currently unknown. Retrofit probably doesn't need to protect against this as there could be multiple forms for the same endpoint on the client side. However, installing multiple handlers for the same endpoint might lead to confusing behavior on the server side and should probably not be allowed.

Support multiple interfaces in service

Right now you only support services that have a single super class

https://github.com/bnorm/ktor-retrofit/blob/master/ktor-retrofit/src/main/kotlin/com/bnorm/ktor/retrofit/RetrofitService.kt#L59

Is there a technical reason for this? I have a branch running it fine without that check and as of Retrofit 2.7 it supports this as well.

Example (this currently crashes)

interface Network: NetworkOne, NetworkTwo

class Services(
    networkOne: NetworkOne,
    networkTwo: NetworkTwo
) : Network,
    NetworkOneby networkOne,
    NetworkTwoby networkTwo

retrofitService(service = Services(networkOne, networkTwo))

How to get the call object in ServiceApi

Or get authention info in ServiceApi

How to wrap the service inside authenticate{}?

I'd like to use io.ktor.auth's authentication and just stick the implementation of ktor-retrofit Service inside the authenticate{} block.

What's the recommended way to do this?

Something like this?

            authenticate("myService") {
                install(RetrofitService) {
                    service(service = MyService)
                }
            }

This doesn't look right and for having multiple services I'll need to do install() multiple times. What's the right way?