forked from loafle/openapi-generator-original
353320cb04
* add validteJsonElement * add oneOf support * various fixes, add tests * minor fixes * minor fixes * update data class * remove comments * array support, add test * update api client constructor * add anyOf support * add new files * fix merge * update * update * update * update
104 lines
5.8 KiB
Markdown
104 lines
5.8 KiB
Markdown
# org.openapitools.client - Kotlin client library for Echo Server API
|
|
|
|
Echo Server API
|
|
|
|
## 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: 0.1.0
|
|
- Package version:
|
|
- Generator version: 7.7.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 *http://localhost:3000*
|
|
|
|
| Class | Method | HTTP request | Description |
|
|
| ------------ | ------------- | ------------- | ------------- |
|
|
| *AuthApi* | [**testAuthHttpBasic**](docs/AuthApi.md#testauthhttpbasic) | **POST** /auth/http/basic | To test HTTP basic authentication |
|
|
| *AuthApi* | [**testAuthHttpBearer**](docs/AuthApi.md#testauthhttpbearer) | **POST** /auth/http/bearer | To test HTTP bearer authentication |
|
|
| *BodyApi* | [**testBinaryGif**](docs/BodyApi.md#testbinarygif) | **POST** /binary/gif | Test binary (gif) response body |
|
|
| *BodyApi* | [**testBodyApplicationOctetstreamBinary**](docs/BodyApi.md#testbodyapplicationoctetstreambinary) | **POST** /body/application/octetstream/binary | Test body parameter(s) |
|
|
| *BodyApi* | [**testBodyMultipartFormdataArrayOfBinary**](docs/BodyApi.md#testbodymultipartformdataarrayofbinary) | **POST** /body/application/octetstream/array_of_binary | Test array of binary in multipart mime |
|
|
| *BodyApi* | [**testBodyMultipartFormdataSingleBinary**](docs/BodyApi.md#testbodymultipartformdatasinglebinary) | **POST** /body/application/octetstream/single_binary | Test single binary in multipart mime |
|
|
| *BodyApi* | [**testEchoBodyFreeFormObjectResponseString**](docs/BodyApi.md#testechobodyfreeformobjectresponsestring) | **POST** /echo/body/FreeFormObject/response_string | Test free form object |
|
|
| *BodyApi* | [**testEchoBodyPet**](docs/BodyApi.md#testechobodypet) | **POST** /echo/body/Pet | Test body parameter(s) |
|
|
| *BodyApi* | [**testEchoBodyPetResponseString**](docs/BodyApi.md#testechobodypetresponsestring) | **POST** /echo/body/Pet/response_string | Test empty response body |
|
|
| *BodyApi* | [**testEchoBodyTagResponseString**](docs/BodyApi.md#testechobodytagresponsestring) | **POST** /echo/body/Tag/response_string | Test empty json (request body) |
|
|
| *FormApi* | [**testFormIntegerBooleanString**](docs/FormApi.md#testformintegerbooleanstring) | **POST** /form/integer/boolean/string | Test form parameter(s) |
|
|
| *FormApi* | [**testFormOneof**](docs/FormApi.md#testformoneof) | **POST** /form/oneof | Test form parameter(s) for oneOf schema |
|
|
| *HeaderApi* | [**testHeaderIntegerBooleanStringEnums**](docs/HeaderApi.md#testheaderintegerbooleanstringenums) | **GET** /header/integer/boolean/string/enums | Test header parameter(s) |
|
|
| *PathApi* | [**testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath**](docs/PathApi.md#testspathstringpathstringintegerpathintegerenumnonrefstringpathenumrefstringpath) | **GET** /path/string/{path_string}/integer/{path_integer}/{enum_nonref_string_path}/{enum_ref_string_path} | Test path parameter(s) |
|
|
| *QueryApi* | [**testEnumRefString**](docs/QueryApi.md#testenumrefstring) | **GET** /query/enum_ref_string | Test query parameter(s) |
|
|
| *QueryApi* | [**testQueryDatetimeDateString**](docs/QueryApi.md#testquerydatetimedatestring) | **GET** /query/datetime/date/string | Test query parameter(s) |
|
|
| *QueryApi* | [**testQueryIntegerBooleanString**](docs/QueryApi.md#testqueryintegerbooleanstring) | **GET** /query/integer/boolean/string | Test query parameter(s) |
|
|
| *QueryApi* | [**testQueryStyleDeepObjectExplodeTrueObject**](docs/QueryApi.md#testquerystyledeepobjectexplodetrueobject) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s) |
|
|
| *QueryApi* | [**testQueryStyleFormExplodeTrueArrayString**](docs/QueryApi.md#testquerystyleformexplodetruearraystring) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s) |
|
|
| *QueryApi* | [**testQueryStyleFormExplodeTrueObject**](docs/QueryApi.md#testquerystyleformexplodetrueobject) | **GET** /query/style_form/explode_true/object | Test query parameter(s) |
|
|
|
|
|
|
<a id="documentation-for-models"></a>
|
|
## Documentation for Models
|
|
|
|
- [org.openapitools.client.models.Bird](docs/Bird.md)
|
|
- [org.openapitools.client.models.Category](docs/Category.md)
|
|
- [org.openapitools.client.models.DefaultValue](docs/DefaultValue.md)
|
|
- [org.openapitools.client.models.NumberPropertiesOnly](docs/NumberPropertiesOnly.md)
|
|
- [org.openapitools.client.models.Pet](docs/Pet.md)
|
|
- [org.openapitools.client.models.Query](docs/Query.md)
|
|
- [org.openapitools.client.models.StringEnumRef](docs/StringEnumRef.md)
|
|
- [org.openapitools.client.models.Tag](docs/Tag.md)
|
|
- [org.openapitools.client.models.TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter](docs/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.md)
|
|
|
|
|
|
<a id="documentation-for-authorization"></a>
|
|
## Documentation for Authorization
|
|
|
|
|
|
Authentication schemes defined for the API:
|
|
<a id="http_auth"></a>
|
|
### http_auth
|
|
|
|
- **Type**: HTTP basic authentication
|
|
|
|
<a id="http_bearer_auth"></a>
|
|
### http_bearer_auth
|
|
|
|
- **Type**: HTTP Bearer Token authentication
|
|
|
|
|
|
|
|
## Author
|
|
|
|
team@openapitools.org
|