openapi-generator/samples/client/petstore/java-micronaut-client/docs/apis/FakeApi.md

FakeApi

All URIs are relative to http://petstore.swagger.io:80/v2

Method	HTTP request	Description
createXmlItem	POST /fake/create_xml_item	creates an XmlItem
fakeOuterBooleanSerialize	POST /fake/outer/boolean
fakeOuterCompositeSerialize	POST /fake/outer/composite
fakeOuterNumberSerialize	POST /fake/outer/number
fakeOuterStringSerialize	POST /fake/outer/string
testBodyWithFileSchema	PUT /fake/body-with-file-schema
testBodyWithQueryParams	PUT /fake/body-with-query-params
testClientModel	PATCH /fake	To test "client" model
testEndpointParameters	POST /fake	Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
testEnumParameters	GET /fake	To test enum parameters
testGroupParameters	DELETE /fake	Fake endpoint to test group parameters (optional)
testInlineAdditionalProperties	POST /fake/inline-additionalProperties	test inline additionalProperties
testJsonFormData	GET /fake/jsonFormData	test json serialization of form data
testQueryParameterCollectionFormat	PUT /fake/test-query-parameters

Creating FakeApi

To initiate an instance of FakeApi, you can use micronaut's ApplicationContext:

/* imports
import io.micronaut.runtime.Micronaut;
import io.micronaut.context.ApplicationContext;
import org.openapitools.api.FakeApi;
*/

ApplicationContext context = Micronaut.run(/* ... */);
PetApi apiInstance = context.getBean(FakeApi.class);

Or the @Inject annotation:

@Singleton
class MyClass {
    @Inject
    FakeApi fakeApi;

    /* ... use the injected variable */
}

Note that the class needs to be annotated with one of Micronaut's scope annotations like Singleton in order to be processed.

More information can be found inside Inversion of Control guide section.

createXmlItem

Mono<Void> FakeApi.createXmlItem(xmlItem)

creates an XmlItem

this route creates an XmlItem

Parameters

Name	Type	Description	Notes
xmlItem	XmlItem	XmlItem Body

HTTP request headers

• Content-Type: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16
• Accept: Not defined

fakeOuterBooleanSerialize

Mono<Boolean> FakeApi.fakeOuterBooleanSerialize(_body)

Test serialization of outer boolean types

Parameters

Name	Type	Description	Notes
_body	Boolean	Input boolean as post body	[optional parameter]

Return type

Boolean

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

fakeOuterCompositeSerialize

Mono<OuterComposite> FakeApi.fakeOuterCompositeSerialize(_body)

Test serialization of object with outer number type

Parameters

Name	Type	Description	Notes
_body	OuterComposite	Input composite as post body	[optional parameter]

Return type

OuterComposite

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

fakeOuterNumberSerialize

Mono<BigDecimal> FakeApi.fakeOuterNumberSerialize(_body)

Test serialization of outer number types

Parameters

Name	Type	Description	Notes
_body	BigDecimal	Input number as post body	[optional parameter]

Return type

BigDecimal

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

fakeOuterStringSerialize

Mono<String> FakeApi.fakeOuterStringSerialize(_body)

Test serialization of outer string types

Parameters

Name	Type	Description	Notes
_body	String	Input string as post body	[optional parameter]

Return type

String

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

testBodyWithFileSchema

Mono<Void> FakeApi.testBodyWithFileSchema(_body)

For this test, the body for this request much reference a schema named `File`.

Parameters

Name	Type	Description	Notes
_body	FileSchemaTestClass

HTTP request headers

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

testBodyWithQueryParams

Mono<Void> FakeApi.testBodyWithQueryParams(query_body)

Parameters

Name	Type	Description	Notes
query	String
_body	User

HTTP request headers

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

testClientModel

Mono<ModelClient> FakeApi.testClientModel(_body)

To test "client" model

To test "client" model

Parameters

Name	Type	Description	Notes
_body	ModelClient	client model

Return type

ModelClient

HTTP request headers

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

testEndpointParameters

Mono<Void> FakeApi.testEndpointParameters(number_doublepatternWithoutDelimiter_byteintegerint32int64_floatstringbinarydatedateTimepasswordparamCallback)

Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트

Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트

Parameters

Name	Type	Description	Notes
number	BigDecimal	None
_double	Double	None
patternWithoutDelimiter	String	None
_byte	byte[]	None
integer	Integer	None	[optional parameter]
int32	Integer	None	[optional parameter]
int64	Long	None	[optional parameter]
_float	Float	None	[optional parameter]
string	String	None	[optional parameter]
binary	File	None	[optional parameter]
date	LocalDate	None	[optional parameter]
dateTime	OffsetDateTime	None	[optional parameter]
password	String	None	[optional parameter]
paramCallback	String	None	[optional parameter]

Authorization

• http_basic_test

HTTP request headers

• Content-Type: application/x-www-form-urlencoded
• Accept: Not defined

testEnumParameters

Mono<Void> FakeApi.testEnumParameters(enumHeaderStringArrayenumHeaderStringenumQueryStringArrayenumQueryStringenumQueryIntegerenumQueryDoubleenumFormStringArrayenumFormString)

To test enum parameters

To test enum parameters

Parameters

Name	Type	Description	Notes
enumHeaderStringArray	List<String>	Header parameter enum test (string array)	[optional parameter] [enum: >, $]
enumHeaderString	String	Header parameter enum test (string)	[optional parameter] [default to -efg] [enum: _abc, -efg, (xyz)]
enumQueryStringArray	List<String>	Query parameter enum test (string array)	[optional parameter] [enum: >, $]
enumQueryString	String	Query parameter enum test (string)	[optional parameter] [default to -efg] [enum: _abc, -efg, (xyz)]
enumQueryInteger	Integer	Query parameter enum test (double)	[optional parameter] [enum: 1, -2]
enumQueryDouble	Double	Query parameter enum test (double)	[optional parameter] [enum: 1.1, -1.2]
enumFormStringArray	List<String>	Form parameter enum test (string array)	[optional parameter] [default to $] [enum: >, $]
enumFormString	String	Form parameter enum test (string)	[optional parameter] [default to -efg] [enum: _abc, -efg, (xyz)]

HTTP request headers

• Content-Type: application/x-www-form-urlencoded
• Accept: Not defined

testGroupParameters

Mono<Void> FakeApi.testGroupParameters(requiredStringGrouprequiredBooleanGrouprequiredInt64GroupstringGroupbooleanGroupint64Group)

Fake endpoint to test group parameters (optional)

Fake endpoint to test group parameters (optional)

Parameters

Name	Type	Description	Notes
requiredStringGroup	Integer	Required String in group parameters
requiredBooleanGroup	Boolean	Required Boolean in group parameters
requiredInt64Group	Long	Required Integer in group parameters
stringGroup	Integer	String in group parameters	[optional parameter]
booleanGroup	Boolean	Boolean in group parameters	[optional parameter]
int64Group	Long	Integer in group parameters	[optional parameter]

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

testInlineAdditionalProperties

Mono<Void> FakeApi.testInlineAdditionalProperties(param)

test inline additionalProperties

Parameters

Name	Type	Description	Notes
param	Map<String, String>	request body

HTTP request headers

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

testJsonFormData

Mono<Void> FakeApi.testJsonFormData(paramparam2)

test json serialization of form data

Parameters

Name	Type	Description	Notes
param	String	field1
param2	String	field2

HTTP request headers

• Content-Type: application/x-www-form-urlencoded
• Accept: Not defined

testQueryParameterCollectionFormat

Mono<Void> FakeApi.testQueryParameterCollectionFormat(pipeioutilhttpurlcontext)

To test the collection format in query parameters

Parameters

Name	Type	Description	Notes
pipe	List<String>
ioutil	List<String>
http	List<String>
url	List<String>
context	List<String>

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined