openapi-generator-original/samples/client/others/kotlin-jvm-okhttp-path-comments/README.md

org.openapitools.client - Kotlin client library for OpenAPI Stuff API created to reproduce issue

Example created

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:
• Generator version: 7.13.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.

Documentation for API Endpoints

All URIs are relative to https://example.org/v1

Class	Method	HTTP request	Description
StuffApi	findStuff	GET /foo/*	Finds stuff

Documentation for Models

• org.openapitools.client.models.FindStuff200Response

Documentation for Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: HTTP Bearer Token authentication (JWT)