mirror of
https://github.com/OpenAPITools/openapi-generator.git
synced 2025-05-14 05:30:51 +00:00
org.openapitools.client - Kotlin client library for Example
An example
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: 0.1
- Package version:
- Build package: org.openapitools.codegen.languages.KotlinClientCodegen For more information, please visit https://example.org
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://example.org
Class | Method | HTTP request | Description |
---|---|---|---|
BirdApi | getBird | GET /v1/bird/{id} |
Documentation for Models
- org.openapitools.client.models.Animal
- org.openapitools.client.models.Bird
- org.openapitools.client.models.BirdAllOf
Documentation for Authorization
All endpoints do not require authorization.