Kotlin multiplatform client by andrewemery · Pull Request #3900 · OpenAPITools/openapi-generator

andrewemery · 2019-09-17T04:19:57Z

Support for the generation of Kotlin Multiplatform clients.

Background

The kotlin language defined in the Swagger Codegen project currently generates a Kotlin client that can run on the JVM. Somewhat recently, JetBrains introduced Kotlin Multiplatform, a platform that provides the ability to share code between various platforms: JVM, JS, iOS, Windows, etc. This pull request adds the ability to generate a Kotlin Multiplatform client.

Library

The pull request includes Kotlin Multiplatform generation under the kotlin language and introduces two library options:

jvm: (default) to target the existing Kotlin JVM generation.
multiplatform: to target Kotlin Multiplatform generation.

Limitations

The current pull request only currently adds support for JVM and iOS platforms but support for other platforms should be trivial to add.

At present, date and date-time objects are rendered as strings. No attempt is made to integrate any third-party date/time libraries.

Tests

The current implementation doesn't include any tests beyond those already included as part of the kotlin language implementation. A test project can be found here that generates the petstore sample and includes tests to verify the correctness of the implementation.

Comments welcome.

References

#3899
https://github.com/andrewemery/openapi-generator-kotlin-multiplatform-petstore

Kotlin multiplatform allows Kotlin code to be shared across various target platforms. This implementation generates Swagger clients for JVM and iOS platforms.

wing328 · 2019-09-17T17:04:09Z

bin/windows/kotlin-client-petstore-multiplatform.bat

+)
+
+REM set JAVA_OPTS=%JAVA_OPTS% -Xmx1024M -DloggerPath=conf/log4j.properties
+set ags=generate  --artifact-id "kotlin-client-petstore-multiplatform" -i modules\swagger-codegen\src\test\resources\2_0\petstore.yaml -g kotlin --library multiplatform -o samples\client\petstore\kotlin-multiplatform


For -i, please use modules\openapi-generator\src\test\resources\2_0\petstore.yaml instead

Thanks. Updated.

wing328 · 2019-09-18T03:54:50Z

Please run the following to update the documentation so as to address the CircleCI failure:

"./bin/utils/export_docs_generators.sh"
"./bin/utils/copy-to-website.sh"
"./bin/utils/export_generators_readme.sh"

wing328 · 2019-09-19T06:30:51Z

.../openapi-generator/src/main/java/org/openapitools/codegen/languages/KotlinClientCodegen.java

+    @Override
+    public Map<String, Object> postProcessModels(Map<String, Object> objs) {
+
+        // workaround for: https://github.com/swagger-api/swagger-codegen/issues/4258


Do we still need this workaround?

I think the issue has been fixed in OpenAPI Generator

Not sure. I couldn't find a reference to the issue in OpenAPI Generator (and I couldn't remember in what scenario it was necessary). I'll run through some tests and get back to you.

Yes, please. If it's still an issue, we need to track it and get it fixed.

Confirmed fixed. Unnecessary code removed.

I've also included a fix for this issue. Happy to submit as a separate pull request if desired.

#3917

Prefer a separate PR

Separate pull request created:
#3928

OpenAPITools#3917

wing328 · 2019-09-21T09:59:56Z

I got the following errors when testing the multiplatform client locally:

➜  kotlin-multiplatform git:(andrewemery-kotlin-multiplatform-client) ✗ gradle build
Starting a Gradle Daemon (subsequent builds will be faster)

> Configure project :
Kotlin Multiplatform Projects are an experimental feature.

Please wait while Kotlin/Native compiler 1.3.50 is being installed.
Download https://download.jetbrains.com/kotlin/native/builds/releases/1.3.50/macos/kotlin-native-macos-1.3.50.tar.gz
Download https://download.jetbrains.com/kotlin/native/builds/releases/1.3.50/macos/kotlin-native-macos-1.3.50.tar.gz finished, took 30 s 697 ms
Unpack Kotlin/Native compiler to /Users/williamcheng/.konan/kotlin-native-macos-1.3.50
Unpack Kotlin/Native compiler to /Users/williamcheng/.konan/kotlin-native-macos-1.3.50 finished, took 28 s 111 ms

> Task :compileKotlinIosArm64 FAILED

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':compileKotlinIosArm64'.
> Could not resolve all files for configuration ':iosArm64CompileKlibraries'.
   > Could not resolve org.jetbrains.kotlinx:kotlinx-coroutines-core-native:1.3.1.
     Required by:
         project :
      > Could not resolve org.jetbrains.kotlinx:kotlinx-coroutines-core-native:1.3.1.
         > Could not parse module metadata https://jcenter.bintray.com/org/jetbrains/kotlinx/kotlinx-coroutines-core-native/1.3.1/kotlinx-coroutines-core-native-1.3.1.module
            > Unsupported format version '1.0' specified in module metadata. This version of Gradle supports format version 0.4 only.
   > Could not resolve org.jetbrains.kotlinx:kotlinx-coroutines-core-native:1.3.1.
     Required by:
         project : > io.ktor:ktor-client-ios-iosarm64:1.2.4
         project : > io.ktor:ktor-client-json-iosarm64:1.2.4
         project : > io.ktor:ktor-client-serialization-iosarm64:1.2.4
         project : > io.ktor:ktor-client-ios-iosarm64:1.2.4 > io.ktor:ktor-client-core-native:1.2.4 > io.ktor:ktor-client-core-iosarm64:1.2.4
         project : > io.ktor:ktor-client-ios-iosarm64:1.2.4 > org.jetbrains.kotlinx:kotlinx-coroutines-io-native:0.1.14 > org.jetbrains.kotlinx:kotlinx-coroutines-io-iosarm64:0.1.14
         project : > io.ktor:ktor-client-ios-iosarm64:1.2.4 > io.ktor:ktor-client-core-native:1.2.4 > io.ktor:ktor-client-core-iosarm64:1.2.4 > io.ktor:ktor-http-native:1.2.4 > io.ktor:ktor-http-iosarm64:1.2.4
         project : > io.ktor:ktor-client-ios-iosarm64:1.2.4 > io.ktor:ktor-client-core-native:1.2.4 > io.ktor:ktor-client-core-iosarm64:1.2.4 > io.ktor:ktor-http-cio-native:1.2.4 > io.ktor:ktor-http-cio-iosarm64:1.2.4
         project : > io.ktor:ktor-client-ios-iosarm64:1.2.4 > io.ktor:ktor-client-core-native:1.2.4 > io.ktor:ktor-client-core-iosarm64:1.2.4 > io.ktor:ktor-http-native:1.2.4 > io.ktor:ktor-http-iosarm64:1.2.4 > io.ktor:ktor-utils-native:1.2.4 > io.ktor:ktor-utils-iosarm64:1.2.4
      > Could not resolve org.jetbrains.kotlinx:kotlinx-coroutines-core-native:1.3.1.
         > Could not parse module metadata https://jcenter.bintray.com/org/jetbrains/kotlinx/kotlinx-coroutines-core-native/1.3.1/kotlinx-coroutines-core-native-1.3.1.module
            > Unsupported format version '1.0' specified in module metadata. This version of Gradle supports format version 0.4 only.

* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights.

* Get more help at https://help.gradle.org

BUILD FAILED in 2m 11s
1 actionable task: 1 executed

Is it supposed to work on Mac as well?

andrewemery · 2019-09-21T11:42:37Z

I got the following errors when testing the multiplatform client locally:

Try it with the wrapper:

./samples/client/petstore/kotlin-multiplatform/gradlew assemble

Is it supposed to work on Mac as well?

Yes. I've tested on Mac and Windows.

wing328 · 2019-09-21T13:42:06Z

Thanks for the tips. It works for me in my machine:

CONST Null type=kotlin.Nothing? value=null

> Task :compileKotlinMetadata
w: /Users/williamcheng/Code/openapi-generator/samples/client/petstore/kotlin-multiplatform/src/commonMain/kotlin/org/openapitools/client/apis/PetApi.kt: (124, 15): Unnecessary safe call on a non-null receiver of type Array<String>
w: /Users/williamcheng/Code/openapi-generator/samples/client/petstore/kotlin-multiplatform/src/commonMain/kotlin/org/openapitools/client/apis/PetApi.kt: (169, 13): Unnecessary safe call on a non-null receiver of type Array<String>
w: /Users/williamcheng/Code/openapi-generator/samples/client/petstore/kotlin-multiplatform/src/commonMain/kotlin/org/openapitools/client/apis/PetApi.kt: (314, 119): This declaration is experimental and its usage should be marked with '@io.ktor.util.KtorExperimentalAPI' or '@UseExperimental(io.ktor.util.KtorExperimentalAPI::class)'
w: /Users/williamcheng/Code/openapi-generator/samples/client/petstore/kotlin-multiplatform/src/commonMain/kotlin/org/openapitools/client/apis/UserApi.kt: (239, 17): Unnecessary safe call on a non-null receiver of type String
w: /Users/williamcheng/Code/openapi-generator/samples/client/petstore/kotlin-multiplatform/src/commonMain/kotlin/org/openapitools/client/apis/UserApi.kt: (241, 17): Unnecessary safe call on a non-null receiver of type String

BUILD SUCCESSFUL in 10m 1s
13 actionable tasks: 13 executed

wing328 · 2019-09-21T13:47:26Z

.../petstore/kotlin-multiplatform/src/commonMain/kotlin/org/openapitools/client/apis/UserApi.kt

+
+
+
+


Too many empty lines. I'll see what I can do to fix these in a separate PR

wing328

LGTM. Tested locally and the result is good.

wing328 · 2019-09-27T09:14:20Z

Tweet: https://twitter.com/oas_generator/status/1177513352844607488

Hacker News: https://news.ycombinator.com/item?id=21089885

Reddit: https://www.reddit.com/r/Kotlin/comments/d9xndy/openapi_generators_kotlin_client_generator_now/

andrewemery · 2019-09-27T13:45:24Z

Thanks. Looking forward to community feedback and improvements.

This was referenced Sep 17, 2019

[REQ] Kotlin Multiplatform client #3899

Closed

Supprt Kotlin Multiplatform client generation swagger-api/swagger-codegen#9703

Open

andrewemery added 4 commits September 17, 2019 14:38

Includes Kotlin multiplatform client

adc7077

Kotlin multiplatform allows Kotlin code to be shared across various target platforms. This implementation generates Swagger clients for JVM and iOS platforms.

Includes Kotlin Multiplatform sample scripts

6d3eff5

Updates existing Kotlin samples

6de2951

Includes Kotlin Multiplatform samples

44fec6f

andrewemery force-pushed the kotlin-multiplatform-client branch from eb95cd0 to 44fec6f Compare September 17, 2019 04:38

wing328 reviewed Sep 17, 2019

View reviewed changes

Fixes incorrect Windows sample resource location

6b7f01f

wing328 added Client: Kotlin Enhancement: Feature labels Sep 18, 2019

wing328 added this to the 4.1.3 milestone Sep 18, 2019

Updates Kotlin client documentation

2374e10

wing328 reviewed Sep 19, 2019

View reviewed changes

andrewemeryanz added 4 commits September 20, 2019 09:14

Removes unnecessary workaround to remove duplicate entries

61b2195

Includes additional multiplatform type and import mappings

3ba909e

Fixes Kotlin client definitions with multiple enums

8aa2ca5

OpenAPITools#3917

Updates Kotlin samples

4d05fec

wing328 reviewed Sep 21, 2019

View reviewed changes

wing328 approved these changes Sep 21, 2019

View reviewed changes

wing328 merged commit 21e0e0d into OpenAPITools:master Sep 21, 2019

andrewemery mentioned this pull request Sep 25, 2019

Kotlin client multiple enums #3928

Closed

ATchernov mentioned this pull request Dec 30, 2019

Update API generation with openapi-generator (kotlin/multiplatform instead of Kotlin/jvm) icerockdev/moko-network#3

Open

michalharakal mentioned this pull request Jan 2, 2020

Replace hand writen remote client with code generated from OpenApi definition dukecon/dukecon_mobile#4

Closed

ahmetcj4 mentioned this pull request Apr 2, 2020

Multiplatform base lenstech/chatter-cloud#19

Closed

8 tasks

Uh oh!

Conversation

andrewemery commented Sep 17, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wing328 commented Sep 18, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wing328 commented Sep 21, 2019

Uh oh!

andrewemery commented Sep 21, 2019

Uh oh!

wing328 commented Sep 21, 2019

Uh oh!

Choose a reason for hiding this comment

Uh oh!

wing328 left a comment

Choose a reason for hiding this comment

Uh oh!

wing328 commented Sep 27, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

andrewemery commented Sep 27, 2019

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

wing328 commented Sep 27, 2019 •

edited

Loading