mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-05-13 05:00:50 +00:00

[kotlin] cleanup documentation (#15307 )

* [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>

2023-04-27 11:33:15 +01:00

1.6 KiB

Raw Blame History

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 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://localhost

Class	Method	HTTP request	Description
DefaultApi	idsGet	GET /{ids}

Documentation for Models

Documentation for Authorization

Endpoints do not require authorization.

1.6 KiB Raw Blame History