forked from loafle/openapi-generator-original
This commit fixes an issue where the object mapper is not passed to the JacksonConverterFactory. The issue causing the serialization to fail when passing to the ApiClient a pre-configured mapper object (e.g. the primary bean of SpringBoot). With this fix, the bean would be correctly passed to the factory, and the serialization would work "out of the box" for the pre-configured bean.
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 project. By using the openapi-spec from a remote server, you can easily generate an API client.
- API version: 1.0.0
- Package version:
- 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.
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
- org.openapitools.client.models.Category
- org.openapitools.client.models.ModelApiResponse
- org.openapitools.client.models.Order
- org.openapitools.client.models.Pet
- org.openapitools.client.models.Tag
- org.openapitools.client.models.User
Documentation for Authorization
Authentication schemes defined for the API:
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
api_key
- Type: API key
- API key parameter name: api_key
- Location: HTTP header