-
-
Notifications
You must be signed in to change notification settings - Fork 7.2k
[Kotlin] opt-in builder + DSL for generated models #21791
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
Open
nikile1123
wants to merge
3
commits into
OpenAPITools:master
Choose a base branch
from
nikile1123:nikile1123/kotlin-generate-model-builders-flag
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
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 hidden or 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,6 @@ | ||
| generatorName: kotlin | ||
| outputDir: samples/client/petstore/kotlin-generateModelBuilders | ||
| inputSpec: modules/openapi-generator/src/test/resources/3_1/petstore.yaml | ||
| templateDir: modules/openapi-generator/src/main/resources/kotlin-client | ||
| additionalProperties: | ||
| generateModelBuilders: "true" | ||
This file contains hidden or 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 hidden or 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
23 changes: 23 additions & 0 deletions
23
samples/client/petstore/kotlin-generateModelBuilders/.openapi-generator-ignore
This file contains hidden or 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 |
42 changes: 42 additions & 0 deletions
42
samples/client/petstore/kotlin-generateModelBuilders/.openapi-generator/FILES
This file contains hidden or 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,42 @@ | ||
| 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 | ||
| gradle/wrapper/gradle-wrapper.jar | ||
| gradle/wrapper/gradle-wrapper.properties | ||
| gradlew | ||
| gradlew.bat | ||
| 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/infrastructure/ApiAbstractions.kt | ||
| src/main/kotlin/org/openapitools/client/infrastructure/ApiClient.kt | ||
| src/main/kotlin/org/openapitools/client/infrastructure/ApiResponse.kt | ||
| src/main/kotlin/org/openapitools/client/infrastructure/BigDecimalAdapter.kt | ||
| src/main/kotlin/org/openapitools/client/infrastructure/BigIntegerAdapter.kt | ||
| src/main/kotlin/org/openapitools/client/infrastructure/ByteArrayAdapter.kt | ||
| src/main/kotlin/org/openapitools/client/infrastructure/Errors.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/PartConfig.kt | ||
| src/main/kotlin/org/openapitools/client/infrastructure/RequestConfig.kt | ||
| src/main/kotlin/org/openapitools/client/infrastructure/RequestMethod.kt | ||
| src/main/kotlin/org/openapitools/client/infrastructure/ResponseExtensions.kt | ||
| src/main/kotlin/org/openapitools/client/infrastructure/Serializer.kt | ||
| src/main/kotlin/org/openapitools/client/infrastructure/URIAdapter.kt | ||
| src/main/kotlin/org/openapitools/client/infrastructure/UUIDAdapter.kt | ||
| src/main/kotlin/org/openapitools/client/models/Category.kt | ||
| src/main/kotlin/org/openapitools/client/models/ModelApiResponse.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-generateModelBuilders/.openapi-generator/VERSION
This file contains hidden or 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 @@ | ||
| 7.15.0-SNAPSHOT |
102 changes: 102 additions & 0 deletions
102
samples/client/petstore/kotlin-generateModelBuilders/README.md
This file contains hidden or 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,102 @@ | ||
| # org.openapitools.client - Kotlin client library for OpenAPI Petstore | ||
|
|
||
| This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters. | ||
|
|
||
| ## Overview | ||
| This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [openapi-spec](https://github.com/OAI/OpenAPI-Specification) from a remote server, you can easily generate an API client. | ||
|
|
||
| - API version: 1.0.0 | ||
| - Package version: | ||
| - Generator version: 7.15.0-SNAPSHOT | ||
| - Build package: org.openapitools.codegen.languages.KotlinClientCodegen | ||
|
|
||
| ## Requires | ||
|
|
||
| * Kotlin 1.7.21 | ||
| * Gradle 7.5 | ||
|
|
||
| ## 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 id="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 id="documentation-for-models"></a> | ||
| ## Documentation for Models | ||
|
|
||
| - [org.openapitools.client.models.Category](docs/Category.md) | ||
| - [org.openapitools.client.models.ModelApiResponse](docs/ModelApiResponse.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 id="documentation-for-authorization"></a> | ||
| ## Documentation for Authorization | ||
|
|
||
|
|
||
| Authentication schemes defined for the API: | ||
| <a id="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 | ||
|
|
||
| <a id="api_key"></a> | ||
| ### api_key | ||
|
|
||
| - **Type**: API key | ||
| - **API key parameter name**: api_key | ||
| - **Location**: HTTP header | ||
|
|
62 changes: 62 additions & 0 deletions
62
samples/client/petstore/kotlin-generateModelBuilders/build.gradle
This file contains hidden or 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,62 @@ | ||
| group 'org.openapitools' | ||
| version '1.0.0' | ||
|
|
||
| wrapper { | ||
| gradleVersion = '8.7' | ||
| distributionUrl = "https://services.gradle.org/distributions/gradle-$gradleVersion-all.zip" | ||
| } | ||
|
|
||
| buildscript { | ||
| ext.kotlin_version = '1.9.23' | ||
| ext.spotless_version = "6.25.0" | ||
|
|
||
| repositories { | ||
| maven { url "https://repo1.maven.org/maven2" } | ||
| } | ||
| dependencies { | ||
| classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version" | ||
| classpath "com.diffplug.spotless:spotless-plugin-gradle:$spotless_version" | ||
| } | ||
| } | ||
|
|
||
| apply plugin: 'kotlin' | ||
| apply plugin: 'maven-publish' | ||
| apply plugin: 'com.diffplug.spotless' | ||
|
|
||
| repositories { | ||
| maven { url "https://repo1.maven.org/maven2" } | ||
| } | ||
|
|
||
| // Use spotless plugin to automatically format code, remove unused import, etc | ||
| // To apply changes directly to the file, run `gradlew spotlessApply` | ||
| // Ref: https://github.com/diffplug/spotless/tree/main/plugin-gradle | ||
| spotless { | ||
| // comment out below to run spotless as part of the `check` task | ||
| enforceCheck false | ||
|
|
||
| format 'misc', { | ||
| // define the files (e.g. '*.gradle', '*.md') to apply `misc` to | ||
| target '.gitignore' | ||
|
|
||
| // define the steps to apply to those files | ||
| trimTrailingWhitespace() | ||
| indentWithSpaces() // Takes an integer argument if you don't like 4 | ||
| endWithNewline() | ||
| } | ||
| kotlin { | ||
| ktfmt() | ||
| } | ||
| } | ||
|
|
||
| test { | ||
| useJUnitPlatform() | ||
| } | ||
|
|
||
| dependencies { | ||
| implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk8:$kotlin_version" | ||
| implementation "org.jetbrains.kotlin:kotlin-reflect:$kotlin_version" | ||
| implementation "com.squareup.moshi:moshi-kotlin:1.15.1" | ||
| implementation "com.squareup.moshi:moshi-adapters:1.15.1" | ||
| implementation "com.squareup.okhttp3:okhttp:4.12.0" | ||
| testImplementation "io.kotlintest:kotlintest-runner-junit5:3.4.2" | ||
| } |
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.
please add the new folder to the github workflow:
https://github.com/OpenAPITools/openapi-generator/blob/master/.github/workflows/samples-kotlin-client.yaml
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.
Done