Compile-time safe Ktorfit

[esafirm]

Hi @Foso, great library! I was thinking of creating something like this but luckily found this first.

My concern with this is that

1. There's a lack of a compile-time safe in the library,create() can throw a runtime error if the compiler plugin is not applied
2. The needs to add an extra Gradle plugin to create the first condition

I assume you chose this design to mimic what Retrofit have, but maybe we can make this better by not doing so?

What I have in mind is to have a generation like Dagger and move the creation to the impl instead

interface  ExampleApi { ... }

// Instead of _ExampleApiImpl
val api = KtorfitExampleApi.create(ktorfit)

Let me know what you think.

Cheers!

[Foso]

Hi @esafirm , thank you. I understand your concerns.
Yes, it was done this was way to mimic Retrofit.

It`s not really documented, but Ktorfit also generates an extension function on Ktorfit for every generated interface implementation.
So you can already do

val api = ktorfit.createExampleApi()

The only issue with that is, that you can use this function only in platform specific modules, not in a common module. This is because KSP only generates code to the platform specific modules. If you just want to use it in Android projects, it should work this way and you don`t need the gradle/compiler plugin

[esafirm]

Ah yes, I forgot about that issue.

I can see that until google/ksp#567 is resolved, the current approach might be a good solution.

[Foso]

Till we find a better solution we will keep the compiler plugin. I would like to find a solution where it's not needed anymore

[Foso]

@esafirm With Ktorfit 2.0.0 I found a way to make the extension functions usable from commonMain. The compiler plugin is for now still part of the project, but when you use the extension functions, the compiler plugin will not be active.