forked from loafle/openapi-generator-original
da96058f5b
* [kotlin] fix documentation of API authorization in README files fix hierarchy level + add internal links + align wording across generators * [kotlin] fix anchor links in documentation --------- Co-authored-by: Tiffany Marrel <tiffany.marrel@flowable.com>
60 lines
1.6 KiB
Markdown
60 lines
1.6 KiB
Markdown
# org.openapitools.client - Kotlin client library for Demo
|
|
|
|
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
|
|
|
## 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:
|
|
- 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://localhost*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*DefaultApi* | [**idsGet**](docs/DefaultApi.md#idsget) | **GET** /{ids} |
|
|
|
|
|
|
<a id="documentation-for-models"></a>
|
|
## Documentation for Models
|
|
|
|
|
|
|
|
<a id="documentation-for-authorization"></a>
|
|
## Documentation for Authorization
|
|
|
|
Endpoints do not require authorization.
|
|
|