-
-
Notifications
You must be signed in to change notification settings - Fork 6.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Kotlin] Rxjava3 support #6998
Merged
Merged
[Kotlin] Rxjava3 support #6998
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
705839a
added rx3 support
82ee91e
fix rx3 support
c8e261c
generated samples
354603a
updated samples
8879d28
update samples
wing328 779be78
changed rxjava3 adapter to the one from squareup
b19f3e5
changed dependency of RxJava3CallAdapterFactory
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
generatorName: kotlin | ||
outputDir: samples/client/petstore/kotlin-retrofit2-rx3 | ||
library: jvm-retrofit2 | ||
inputSpec: modules/openapi-generator/src/test/resources/2_0/petstore.yaml | ||
templateDir: modules/openapi-generator/src/main/resources/kotlin-client | ||
additionalProperties: | ||
artifactId: kotlin-petstore-retrofit2-rx3 | ||
useRxJava3: "true" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -32,6 +32,9 @@ import retrofit2.adapter.rxjava.RxJavaCallAdapterFactory | |
{{#useRxJava2}} | ||
import retrofit2.adapter.rxjava2.RxJava2CallAdapterFactory | ||
{{/useRxJava2}} | ||
{{#useRxJava3}} | ||
import hu.akarnokd.rxjava3.retrofit.RxJava3CallAdapterFactory; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @tgerth since you changed the lib of |
||
{{/useRxJava3}} | ||
{{#gson}} | ||
import com.google.gson.Gson | ||
import com.google.gson.GsonBuilder | ||
|
@@ -62,7 +65,9 @@ import retrofit2.converter.moshi.MoshiConverterFactory | |
{{/useRxJava}} | ||
{{#useRxJava2}} | ||
.addCallAdapterFactory(RxJava2CallAdapterFactory.create()) | ||
{{/useRxJava2}} | ||
{{/useRxJava2}}{{#useRxJava3}} | ||
.addCallAdapterFactory(RxJava3CallAdapterFactory.create()) | ||
{{/useRxJava3}} | ||
{{#moshi}} | ||
.addConverterFactory(MoshiConverterFactory.create(serializerBuilder.build())) | ||
{{/moshi}} | ||
|
23 changes: 23 additions & 0 deletions
23
samples/client/petstore/kotlin-retrofit2-rx3/.openapi-generator-ignore
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,23 @@ | ||
# OpenAPI Generator Ignore | ||
# Generated by openapi-generator https://github.com/openapitools/openapi-generator | ||
|
||
# Use this file to prevent files from being overwritten by the generator. | ||
# The patterns follow closely to .gitignore or .dockerignore. | ||
|
||
# As an example, the C# client generator defines ApiClient.cs. | ||
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: | ||
#ApiClient.cs | ||
|
||
# You can match any string of characters against a directory, file or extension with a single asterisk (*): | ||
#foo/*/qux | ||
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux | ||
|
||
# You can recursively match patterns against a directory, file or extension with a double asterisk (**): | ||
#foo/**/qux | ||
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux | ||
|
||
# You can also negate patterns with an exclamation (!). | ||
# For example, you can ignore all files in a docs folder with the file extension .md: | ||
#docs/*.md | ||
# Then explicitly reverse the ignore rule for a single file: | ||
#!docs/README.md |
34 changes: 34 additions & 0 deletions
34
samples/client/petstore/kotlin-retrofit2-rx3/.openapi-generator/FILES
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
README.md | ||
build.gradle | ||
docs/ApiResponse.md | ||
docs/Category.md | ||
docs/Order.md | ||
docs/Pet.md | ||
docs/PetApi.md | ||
docs/StoreApi.md | ||
docs/Tag.md | ||
docs/User.md | ||
docs/UserApi.md | ||
settings.gradle | ||
src/main/kotlin/org/openapitools/client/apis/PetApi.kt | ||
src/main/kotlin/org/openapitools/client/apis/StoreApi.kt | ||
src/main/kotlin/org/openapitools/client/apis/UserApi.kt | ||
src/main/kotlin/org/openapitools/client/auth/ApiKeyAuth.kt | ||
src/main/kotlin/org/openapitools/client/auth/OAuth.kt | ||
src/main/kotlin/org/openapitools/client/auth/OAuthFlow.kt | ||
src/main/kotlin/org/openapitools/client/auth/OAuthOkHttpClient.kt | ||
src/main/kotlin/org/openapitools/client/infrastructure/ApiClient.kt | ||
src/main/kotlin/org/openapitools/client/infrastructure/ByteArrayAdapter.kt | ||
src/main/kotlin/org/openapitools/client/infrastructure/CollectionFormats.kt | ||
src/main/kotlin/org/openapitools/client/infrastructure/LocalDateAdapter.kt | ||
src/main/kotlin/org/openapitools/client/infrastructure/LocalDateTimeAdapter.kt | ||
src/main/kotlin/org/openapitools/client/infrastructure/OffsetDateTimeAdapter.kt | ||
src/main/kotlin/org/openapitools/client/infrastructure/ResponseExt.kt | ||
src/main/kotlin/org/openapitools/client/infrastructure/Serializer.kt | ||
src/main/kotlin/org/openapitools/client/infrastructure/UUIDAdapter.kt | ||
src/main/kotlin/org/openapitools/client/models/ApiResponse.kt | ||
src/main/kotlin/org/openapitools/client/models/Category.kt | ||
src/main/kotlin/org/openapitools/client/models/Order.kt | ||
src/main/kotlin/org/openapitools/client/models/Pet.kt | ||
src/main/kotlin/org/openapitools/client/models/Tag.kt | ||
src/main/kotlin/org/openapitools/client/models/User.kt |
1 change: 1 addition & 0 deletions
1
samples/client/petstore/kotlin-retrofit2-rx3/.openapi-generator/VERSION
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
5.0.0-SNAPSHOT |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,90 @@ | ||
# org.openapitools.client - Kotlin client library for OpenAPI Petstore | ||
|
||
## Requires | ||
|
||
* Kotlin 1.3.61 | ||
* Gradle 4.9 | ||
|
||
## Build | ||
|
||
First, create the gradle wrapper script: | ||
|
||
``` | ||
gradle wrapper | ||
``` | ||
|
||
Then, run: | ||
|
||
``` | ||
./gradlew check assemble | ||
``` | ||
|
||
This runs all tests and packages the library. | ||
|
||
## Features/Implementation Notes | ||
|
||
* Supports JSON inputs/outputs, File inputs, and Form inputs. | ||
* Supports collection formats for query parameters: csv, tsv, ssv, pipes. | ||
* Some Kotlin and Java types are fully qualified to avoid conflicts with types defined in OpenAPI definitions. | ||
* Implementation of ApiClient is intended to reduce method counts, specifically to benefit Android targets. | ||
|
||
<a name="documentation-for-api-endpoints"></a> | ||
## Documentation for API Endpoints | ||
|
||
All URIs are relative to *http://petstore.swagger.io/v2* | ||
|
||
Class | Method | HTTP request | Description | ||
------------ | ------------- | ------------- | ------------- | ||
*PetApi* | [**addPet**](docs/PetApi.md#addpet) | **POST** pet | Add a new pet to the store | ||
*PetApi* | [**deletePet**](docs/PetApi.md#deletepet) | **DELETE** pet/{petId} | Deletes a pet | ||
*PetApi* | [**findPetsByStatus**](docs/PetApi.md#findpetsbystatus) | **GET** pet/findByStatus | Finds Pets by status | ||
*PetApi* | [**findPetsByTags**](docs/PetApi.md#findpetsbytags) | **GET** pet/findByTags | Finds Pets by tags | ||
*PetApi* | [**getPetById**](docs/PetApi.md#getpetbyid) | **GET** pet/{petId} | Find pet by ID | ||
*PetApi* | [**updatePet**](docs/PetApi.md#updatepet) | **PUT** pet | Update an existing pet | ||
*PetApi* | [**updatePetWithForm**](docs/PetApi.md#updatepetwithform) | **POST** pet/{petId} | Updates a pet in the store with form data | ||
*PetApi* | [**uploadFile**](docs/PetApi.md#uploadfile) | **POST** pet/{petId}/uploadImage | uploads an image | ||
*StoreApi* | [**deleteOrder**](docs/StoreApi.md#deleteorder) | **DELETE** store/order/{orderId} | Delete purchase order by ID | ||
*StoreApi* | [**getInventory**](docs/StoreApi.md#getinventory) | **GET** store/inventory | Returns pet inventories by status | ||
*StoreApi* | [**getOrderById**](docs/StoreApi.md#getorderbyid) | **GET** store/order/{orderId} | Find purchase order by ID | ||
*StoreApi* | [**placeOrder**](docs/StoreApi.md#placeorder) | **POST** store/order | Place an order for a pet | ||
*UserApi* | [**createUser**](docs/UserApi.md#createuser) | **POST** user | Create user | ||
*UserApi* | [**createUsersWithArrayInput**](docs/UserApi.md#createuserswitharrayinput) | **POST** user/createWithArray | Creates list of users with given input array | ||
*UserApi* | [**createUsersWithListInput**](docs/UserApi.md#createuserswithlistinput) | **POST** user/createWithList | Creates list of users with given input array | ||
*UserApi* | [**deleteUser**](docs/UserApi.md#deleteuser) | **DELETE** user/{username} | Delete user | ||
*UserApi* | [**getUserByName**](docs/UserApi.md#getuserbyname) | **GET** user/{username} | Get user by user name | ||
*UserApi* | [**loginUser**](docs/UserApi.md#loginuser) | **GET** user/login | Logs user into the system | ||
*UserApi* | [**logoutUser**](docs/UserApi.md#logoutuser) | **GET** user/logout | Logs out current logged in user session | ||
*UserApi* | [**updateUser**](docs/UserApi.md#updateuser) | **PUT** user/{username} | Updated user | ||
|
||
|
||
<a name="documentation-for-models"></a> | ||
## Documentation for Models | ||
|
||
- [org.openapitools.client.models.ApiResponse](docs/ApiResponse.md) | ||
- [org.openapitools.client.models.Category](docs/Category.md) | ||
- [org.openapitools.client.models.Order](docs/Order.md) | ||
- [org.openapitools.client.models.Pet](docs/Pet.md) | ||
- [org.openapitools.client.models.Tag](docs/Tag.md) | ||
- [org.openapitools.client.models.User](docs/User.md) | ||
|
||
|
||
<a name="documentation-for-authorization"></a> | ||
## Documentation for Authorization | ||
|
||
<a name="api_key"></a> | ||
### api_key | ||
|
||
- **Type**: API key | ||
- **API key parameter name**: api_key | ||
- **Location**: HTTP header | ||
|
||
<a name="petstore_auth"></a> | ||
### petstore_auth | ||
|
||
- **Type**: OAuth | ||
- **Flow**: implicit | ||
- **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog | ||
- **Scopes**: | ||
- write:pets: modify pets in your account | ||
- read:pets: read your pets | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
group 'org.openapitools' | ||
version '1.0.0' | ||
|
||
wrapper { | ||
gradleVersion = '4.9' | ||
distributionUrl = "https://services.gradle.org/distributions/gradle-$gradleVersion-all.zip" | ||
} | ||
|
||
buildscript { | ||
ext.kotlin_version = '1.3.61' | ||
ext.retrofitVersion = '2.6.2' | ||
ext.rxJava3Version = '3.0.4' | ||
|
||
repositories { | ||
maven { url "https://repo1.maven.org/maven2" } | ||
} | ||
dependencies { | ||
classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" | ||
} | ||
} | ||
|
||
apply plugin: 'kotlin' | ||
|
||
repositories { | ||
maven { url "https://repo1.maven.org/maven2" } | ||
} | ||
|
||
test { | ||
useJUnitPlatform() | ||
} | ||
|
||
dependencies { | ||
compile "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version" | ||
compile "org.jetbrains.kotlin:kotlin-reflect:$kotlin_version" | ||
compile "com.squareup.moshi:moshi-kotlin:1.9.2" | ||
compile "com.squareup.moshi:moshi-adapters:1.9.2" | ||
compile "org.apache.oltu.oauth2:org.apache.oltu.oauth2.client:1.0.0" | ||
compile "com.squareup.okhttp3:logging-interceptor:4.4.0" | ||
compile "io.reactivex.rxjava3:rxjava:$rxJava3Version" | ||
compile "com.github.akarnokd:rxjava3-retrofit-adapter:3.0.0" | ||
compile "com.squareup.retrofit2:retrofit:$retrofitVersion" | ||
compile "com.squareup.retrofit2:converter-moshi:$retrofitVersion" | ||
compile "com.squareup.retrofit2:converter-scalars:$retrofitVersion" | ||
testCompile "io.kotlintest:kotlintest-runner-junit5:3.1.0" | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What if we use the RxJava3 adapter from square
com.squareup.retrofit2:adapter-rxjava3
?More info here square/retrofit#3158
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@4brunu When I run
./bin/generate-samples.sh bin/configs/kotlin*
now, the samples will delete all rxjava3 code lines, I don't know why.