openapi-generator/samples/client/echo_api/kotlin-jvm-spring-3-webclient/docs/BodyApi.md

BodyApi

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

Method	HTTP request	Description
testBinaryGif	POST /binary/gif	Test binary (gif) response body
testBodyApplicationOctetstreamBinary	POST /body/application/octetstream/binary	Test body parameter(s)
testBodyMultipartFormdataArrayOfBinary	POST /body/application/octetstream/array_of_binary	Test array of binary in multipart mime
testBodyMultipartFormdataSingleBinary	POST /body/application/octetstream/single_binary	Test single binary in multipart mime
testEchoBodyFreeFormObjectResponseString	POST /echo/body/FreeFormObject/response_string	Test free form object
testEchoBodyPet	POST /echo/body/Pet	Test body parameter(s)
testEchoBodyPetResponseString	POST /echo/body/Pet/response_string	Test empty response body
testEchoBodyTagResponseString	POST /echo/body/Tag/response_string	Test empty json (request body)

testBinaryGif

java.io.File testBinaryGif()

Test binary (gif) response body

Test binary (gif) response body

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*

val apiInstance = BodyApi()
try {
    val result : java.io.File = apiInstance.testBinaryGif()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling BodyApi#testBinaryGif")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling BodyApi#testBinaryGif")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

java.io.File

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: image/gif

testBodyApplicationOctetstreamBinary

kotlin.String testBodyApplicationOctetstreamBinary(body)

Test body parameter(s)

Test body parameter(s)

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*

val apiInstance = BodyApi()
val body : java.io.File = BINARY_DATA_HERE // java.io.File | 
try {
    val result : kotlin.String = apiInstance.testBodyApplicationOctetstreamBinary(body)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling BodyApi#testBodyApplicationOctetstreamBinary")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling BodyApi#testBodyApplicationOctetstreamBinary")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
body	java.io.File		[optional]

Return type

kotlin.String

Authorization

No authorization required

HTTP request headers

• Content-Type: application/octet-stream
• Accept: text/plain

testBodyMultipartFormdataArrayOfBinary

kotlin.String testBodyMultipartFormdataArrayOfBinary(files)

Test array of binary in multipart mime

Test array of binary in multipart mime

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*

val apiInstance = BodyApi()
val files : kotlin.collections.List<java.io.File> = /path/to/file.txt // kotlin.collections.List<java.io.File> | 
try {
    val result : kotlin.String = apiInstance.testBodyMultipartFormdataArrayOfBinary(files)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling BodyApi#testBodyMultipartFormdataArrayOfBinary")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling BodyApi#testBodyMultipartFormdataArrayOfBinary")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
files	kotlin.collections.List<java.io.File>

Return type

kotlin.String

Authorization

No authorization required

HTTP request headers

• Content-Type: multipart/form-data
• Accept: text/plain

testBodyMultipartFormdataSingleBinary

kotlin.String testBodyMultipartFormdataSingleBinary(myFile)

Test single binary in multipart mime

Test single binary in multipart mime

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*

val apiInstance = BodyApi()
val myFile : java.io.File = BINARY_DATA_HERE // java.io.File | 
try {
    val result : kotlin.String = apiInstance.testBodyMultipartFormdataSingleBinary(myFile)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling BodyApi#testBodyMultipartFormdataSingleBinary")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling BodyApi#testBodyMultipartFormdataSingleBinary")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
myFile	java.io.File		[optional]

Return type

kotlin.String

Authorization

No authorization required

HTTP request headers

• Content-Type: multipart/form-data
• Accept: text/plain

testEchoBodyFreeFormObjectResponseString

kotlin.String testEchoBodyFreeFormObjectResponseString(body)

Test free form object

Test free form object

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*

val apiInstance = BodyApi()
val body : kotlin.Any = Object // kotlin.Any | Free form object
try {
    val result : kotlin.String = apiInstance.testEchoBodyFreeFormObjectResponseString(body)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling BodyApi#testEchoBodyFreeFormObjectResponseString")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling BodyApi#testEchoBodyFreeFormObjectResponseString")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
body	kotlin.Any	Free form object	[optional]

Return type

kotlin.String

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: text/plain

testEchoBodyPet

Pet testEchoBodyPet(pet)

Test body parameter(s)

Test body parameter(s)

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*

val apiInstance = BodyApi()
val pet : Pet =  // Pet | Pet object that needs to be added to the store
try {
    val result : Pet = apiInstance.testEchoBodyPet(pet)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling BodyApi#testEchoBodyPet")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling BodyApi#testEchoBodyPet")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
pet	Pet	Pet object that needs to be added to the store	[optional]

Return type

Pet

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: application/json

testEchoBodyPetResponseString

kotlin.String testEchoBodyPetResponseString(pet)

Test empty response body

Test empty response body

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*

val apiInstance = BodyApi()
val pet : Pet =  // Pet | Pet object that needs to be added to the store
try {
    val result : kotlin.String = apiInstance.testEchoBodyPetResponseString(pet)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling BodyApi#testEchoBodyPetResponseString")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling BodyApi#testEchoBodyPetResponseString")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
pet	Pet	Pet object that needs to be added to the store	[optional]

Return type

kotlin.String

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: text/plain

testEchoBodyTagResponseString

kotlin.String testEchoBodyTagResponseString(tag)

Test empty json (request body)

Test empty json (request body)

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*

val apiInstance = BodyApi()
val tag : Tag =  // Tag | Tag object
try {
    val result : kotlin.String = apiInstance.testEchoBodyTagResponseString(tag)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling BodyApi#testEchoBodyTagResponseString")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling BodyApi#testEchoBodyTagResponseString")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
tag	Tag	Tag object	[optional]

Return type

kotlin.String

Authorization

No authorization required

HTTP request headers

• Content-Type: application/json
• Accept: text/plain