loafle/openapi-generator-original
3
0
Fork 1
mirror of https://github.com/OpenAPITools/openapi-generator.git synced 2025-11-03 18:23:44 +00:00
Code Issues Packages Projects Releases Wiki Activity
openapi-generator-original/samples/client/echo_api/kotlin-jvm-spring-3-restclient/README.md
William Cheng 046be5dba1
Prepare 7.15.0 (#21445) 
* Revert "v7.14.0 release (#21443)"

This reverts commit 5eb083e5ce1dd99659fadc03d7c6e809d3077af6.

* prepare v7.15.0 snapshot

* update samples

* update readme

* update doc
2025-06-25 21:34:58 +08:00

5.8 KiB
Raw Blame History

org.openapitools.client - Kotlin client library for Echo Server API

Echo Server API

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.0
  • Package version:
  • Generator version: 7.15.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.

Documentation for API Endpoints

All URIs are relative to http://localhost:3000

Class Method HTTP request Description
AuthApi testAuthHttpBasic POST /auth/http/basic To test HTTP basic authentication
AuthApi testAuthHttpBearer POST /auth/http/bearer To test HTTP bearer authentication
BodyApi testBinaryGif POST /binary/gif Test binary (gif) response body
BodyApi testBodyApplicationOctetstreamBinary POST /body/application/octetstream/binary Test body parameter(s)
BodyApi testBodyMultipartFormdataArrayOfBinary POST /body/application/octetstream/array_of_binary Test array of binary in multipart mime
BodyApi testBodyMultipartFormdataSingleBinary POST /body/application/octetstream/single_binary Test single binary in multipart mime
BodyApi testEchoBodyFreeFormObjectResponseString POST /echo/body/FreeFormObject/response_string Test free form object
BodyApi testEchoBodyPet POST /echo/body/Pet Test body parameter(s)
BodyApi testEchoBodyPetResponseString POST /echo/body/Pet/response_string Test empty response body
BodyApi testEchoBodyTagResponseString POST /echo/body/Tag/response_string Test empty json (request body)
FormApi testFormIntegerBooleanString POST /form/integer/boolean/string Test form parameter(s)
FormApi testFormOneof POST /form/oneof Test form parameter(s) for oneOf schema
HeaderApi testHeaderIntegerBooleanStringEnums GET /header/integer/boolean/string/enums Test header parameter(s)
PathApi testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath GET /path/string/{path_string}/integer/{path_integer}/{enum_nonref_string_path}/{enum_ref_string_path} Test path parameter(s)
QueryApi testEnumRefString GET /query/enum_ref_string Test query parameter(s)
QueryApi testQueryDatetimeDateString GET /query/datetime/date/string Test query parameter(s)
QueryApi testQueryIntegerBooleanString GET /query/integer/boolean/string Test query parameter(s)
QueryApi testQueryStyleDeepObjectExplodeTrueObject GET /query/style_deepObject/explode_true/object Test query parameter(s)
QueryApi testQueryStyleFormExplodeTrueArrayString GET /query/style_form/explode_true/array_string Test query parameter(s)
QueryApi testQueryStyleFormExplodeTrueObject GET /query/style_form/explode_true/object Test query parameter(s)

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

http_auth

  • Type: HTTP basic authentication

http_bearer_auth

  • Type: HTTP Bearer Token authentication

Author

team@openapitools.org