loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity
openapi-generator/samples/client/petstore/kotlin-retrofit2
History
William Cheng 0204bf4ae2 Squashed commit of the following: 
commit c5a0d0f7394aa742fa336fff7e7c1d3049761868
Merge: 8c4991ba3ed f8ff8c87609
Author: William Cheng <wing328hk@gmail.com>
Date:   Tue Aug 17 18:28:12 2021 +0800

    Merge branch 'mustache-linting' of https://github.com/NathanBaulch/openapi-generator into NathanBaulch-mustache-linting

commit f8ff8c87609b1ca36fa26fb8474806999638195e
Author: Nathan Baulch <nathan.baulch@gmail.com>
Date:   Thu Aug 5 14:12:47 2021 +1000

    Reorder tags that handle missing values

commit f5d8a33709d6a3f846a9fe4520b78c3d637051d9
Author: Nathan Baulch <nathan.baulch@gmail.com>
Date:   Thu Aug 5 14:08:59 2021 +1000

    Use dot notation where possible

commit 493d14921e2333f3ae19ef6fc89318b7e263a80c
Author: Nathan Baulch <nathan.baulch@gmail.com>
Date:   Thu Aug 5 14:10:49 2021 +1000

    Remove empty tags

commit 32480dc53f48227d55531b94e307d72671373737
Author: Nathan Baulch <nathan.baulch@gmail.com>
Date:   Thu Aug 5 10:41:58 2021 +1000

    Remove redundant sections

commit a8edabd722c34aa094b4aeb11c22664529c3a219
Author: Nathan Baulch <nathan.baulch@gmail.com>
Date:   Wed Aug 4 22:02:22 2021 +1000

    Trim extra EOF new lines

commit e89bd7458e3594bf0d30e580bc9408e45b018a57
Author: Nathan Baulch <nathan.baulch@gmail.com>
Date:   Wed Aug 4 21:59:26 2021 +1000

    Trim trailing whitespace
2021-08-17 18:37:51 +08:00
..
.openapi-generator
Prepare 5.2.1 release (#10161)
2021-08-16 19:08:29 +08:00
bin/main/org/openapitools/client
[go][client] Fix example value for non string enums (#8900)
2021-03-08 18:11:50 +08:00
docs
[Kotlin][Client] Fix url path for Retrofit, Fix optionals for @Query @Body, Set List as default collection for Kotlin data class (#6456)
2020-06-16 10:33:34 +08:00
gradle/wrapper
[Kotlin][Client] Added Kotlinx Serialization for JVM/Retrofit2/OkHttp3&4 (#6916)
2021-03-19 18:12:23 +08:00
src/main/kotlin/org/openapitools/client
Squashed commit of the following:
2021-08-17 18:37:51 +08:00
.openapi-generator-ignore
Feature/kotlin/library/retrofit (#4518)
2019-12-15 18:26:37 +08:00
build.gradle
[BUG][Kotlin] Add support for collection of generic classes (Jackson / Gson / Moshi) (#9918)
2021-07-24 23:04:14 +08:00
gradlew
[Kotlin][Client] Added Kotlinx Serialization for JVM/Retrofit2/OkHttp3&4 (#6916)
2021-03-19 18:12:23 +08:00
gradlew.bat
[Kotlin][Client] Added Kotlinx Serialization for JVM/Retrofit2/OkHttp3&4 (#6916)
2021-03-19 18:12:23 +08:00
pom.xml
[Kotlin][Client] Added Kotlinx Serialization for JVM/Retrofit2/OkHttp3&4 (#6916)
2021-03-19 18:12:23 +08:00
README.md
[Kotlin][Client] Added Kotlinx Serialization for JVM/Retrofit2/OkHttp3&4 (#6916)
2021-03-19 18:12:23 +08:00
settings.gradle
Feature/kotlin/library/retrofit (#4518)
2019-12-15 18:26:37 +08:00

README.md

org.openapitools.client - Kotlin client library for OpenAPI Petstore

Requires

  • Kotlin 1.4.30
  • Gradle 6.8.3

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.

Documentation for API Endpoints

All URIs are relative to http://petstore.swagger.io/v2

Class Method HTTP request Description
PetApi addPet POST pet Add a new pet to the store
PetApi deletePet DELETE pet/{petId} Deletes a pet
PetApi findPetsByStatus GET pet/findByStatus Finds Pets by status
PetApi findPetsByTags GET pet/findByTags Finds Pets by tags
PetApi getPetById GET pet/{petId} Find pet by ID
PetApi updatePet PUT pet Update an existing pet
PetApi updatePetWithForm POST pet/{petId} Updates a pet in the store with form data
PetApi uploadFile POST pet/{petId}/uploadImage uploads an image
StoreApi deleteOrder DELETE store/order/{orderId} Delete purchase order by ID
StoreApi getInventory GET store/inventory Returns pet inventories by status
StoreApi getOrderById GET store/order/{orderId} Find purchase order by ID
StoreApi placeOrder POST store/order Place an order for a pet
UserApi createUser POST user Create user
UserApi createUsersWithArrayInput POST user/createWithArray Creates list of users with given input array
UserApi createUsersWithListInput POST user/createWithList Creates list of users with given input array
UserApi deleteUser DELETE user/{username} Delete user
UserApi getUserByName GET user/{username} Get user by user name
UserApi loginUser GET user/login Logs user into the system
UserApi logoutUser GET user/logout Logs out current logged in user session
UserApi updateUser PUT user/{username} Updated user

Documentation for Models

Documentation for Authorization

api_key

  • Type: API key
  • API key parameter name: api_key
  • Location: HTTP header

petstore_auth