mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-05-12 12:40:53 +00:00
67 lines
1.8 KiB
Markdown
67 lines
1.8 KiB
Markdown
# 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](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.14.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 *https://example.org/v1*
|
|
|
|
| Class | Method | HTTP request | Description |
|
|
| ------------ | ------------- | ------------- | ------------- |
|
|
| *StuffApi* | [**findStuff**](docs/StuffApi.md#findstuff) | **GET** /foo/* | Finds stuff |
|
|
|
|
|
|
<a id="documentation-for-models"></a>
|
|
## Documentation for Models
|
|
|
|
- [org.openapitools.client.models.FindStuff200Response](docs/FindStuff200Response.md)
|
|
|
|
|
|
<a id="documentation-for-authorization"></a>
|
|
## Documentation for Authorization
|
|
|
|
|
|
Authentication schemes defined for the API:
|
|
<a id="bearerAuth"></a>
|
|
### bearerAuth
|
|
|
|
- **Type**: HTTP Bearer Token authentication (JWT)
|
|
|