openapi-generator/samples/client/petstore/perl/docs/FakeApi.md

WWW::OpenAPIClient::FakeApi

Load the API package

use WWW::OpenAPIClient::Object::FakeApi;

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

Method	HTTP request	Description
create_xml_item	POST /fake/create_xml_item	creates an XmlItem
fake_outer_boolean_serialize	POST /fake/outer/boolean
fake_outer_composite_serialize	POST /fake/outer/composite
fake_outer_number_serialize	POST /fake/outer/number
fake_outer_string_serialize	POST /fake/outer/string
test_body_with_file_schema	PUT /fake/body-with-file-schema
test_body_with_query_params	PUT /fake/body-with-query-params
test_client_model	PATCH /fake	To test "client" model
test_endpoint_parameters	POST /fake	Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
test_enum_parameters	GET /fake	To test enum parameters
test_group_parameters	DELETE /fake	Fake endpoint to test group parameters (optional)
test_inline_additional_properties	POST /fake/inline-additionalProperties	test inline additionalProperties
test_json_form_data	GET /fake/jsonFormData	test json serialization of form data
test_query_parameter_collection_format	PUT /fake/test-query-paramters

create_xml_item

create_xml_item(xml_item => $xml_item)

creates an XmlItem

this route creates an XmlItem

Example

use Data::Dumper;
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
);

my $xml_item = WWW::OpenAPIClient::Object::XmlItem->new(); # XmlItem | XmlItem Body

eval { 
    $api_instance->create_xml_item(xml_item => $xml_item);
};
if ($@) {
    warn "Exception when calling FakeApi->create_xml_item: $@\n";
}

Parameters

Name	Type	Description	Notes
xml_item	XmlItem	XmlItem Body

Return type

void (empty response body)

Authorization

No authorization required

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fake_outer_boolean_serialize

boolean fake_outer_boolean_serialize(body => $body)

Test serialization of outer boolean types

Example

use Data::Dumper;
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
);

my $body = WWW::OpenAPIClient::Object::boolean->new(); # boolean | Input boolean as post body

eval { 
    my $result = $api_instance->fake_outer_boolean_serialize(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FakeApi->fake_outer_boolean_serialize: $@\n";
}

Parameters

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

Return type

boolean

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fake_outer_composite_serialize

OuterComposite fake_outer_composite_serialize(body => $body)

Test serialization of object with outer number type

Example

use Data::Dumper;
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
);

my $body = WWW::OpenAPIClient::Object::OuterComposite->new(); # OuterComposite | Input composite as post body

eval { 
    my $result = $api_instance->fake_outer_composite_serialize(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FakeApi->fake_outer_composite_serialize: $@\n";
}

Parameters

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

Return type

OuterComposite

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fake_outer_number_serialize

double fake_outer_number_serialize(body => $body)

Test serialization of outer number types

Example

use Data::Dumper;
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
);

my $body = WWW::OpenAPIClient::Object::double->new(); # double | Input number as post body

eval { 
    my $result = $api_instance->fake_outer_number_serialize(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FakeApi->fake_outer_number_serialize: $@\n";
}

Parameters

Name	Type	Description	Notes
body	double	Input number as post body	[optional]

Return type

double

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

fake_outer_string_serialize

string fake_outer_string_serialize(body => $body)

Test serialization of outer string types

Example

use Data::Dumper;
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
);

my $body = WWW::OpenAPIClient::Object::string->new(); # string | Input string as post body

eval { 
    my $result = $api_instance->fake_outer_string_serialize(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FakeApi->fake_outer_string_serialize: $@\n";
}

Parameters

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

Return type

string

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

test_body_with_file_schema

test_body_with_file_schema(body => $body)

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

Example

use Data::Dumper;
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
);

my $body = WWW::OpenAPIClient::Object::FileSchemaTestClass->new(); # FileSchemaTestClass | 

eval { 
    $api_instance->test_body_with_file_schema(body => $body);
};
if ($@) {
    warn "Exception when calling FakeApi->test_body_with_file_schema: $@\n";
}

Parameters

Name	Type	Description	Notes
body	FileSchemaTestClass

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

test_body_with_query_params

test_body_with_query_params(query => $query, body => $body)

Example

use Data::Dumper;
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
);

my $query = "query_example"; # string | 
my $body = WWW::OpenAPIClient::Object::User->new(); # User | 

eval { 
    $api_instance->test_body_with_query_params(query => $query, body => $body);
};
if ($@) {
    warn "Exception when calling FakeApi->test_body_with_query_params: $@\n";
}

Parameters

Name	Type	Description	Notes
query	string
body	User

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

test_client_model

Client test_client_model(body => $body)

To test "client" model

To test "client" model

Example

use Data::Dumper;
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
);

my $body = WWW::OpenAPIClient::Object::Client->new(); # Client | client model

eval { 
    my $result = $api_instance->test_client_model(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling FakeApi->test_client_model: $@\n";
}

Parameters

Name	Type	Description	Notes
body	Client	client model

Return type

Client

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

test_endpoint_parameters

test_endpoint_parameters(number => $number, double => $double, pattern_without_delimiter => $pattern_without_delimiter, byte => $byte, integer => $integer, int32 => $int32, int64 => $int64, float => $float, string => $string, binary => $binary, date => $date, date_time => $date_time, password => $password, callback => $callback)

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

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

Example

use Data::Dumper;
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(

    # Configure HTTP basic authorization: http_basic_test
    username => 'YOUR_USERNAME',
    password => 'YOUR_PASSWORD',
    
);

my $number = 3.4; # double | None
my $double = 3.4; # double | None
my $pattern_without_delimiter = "pattern_without_delimiter_example"; # string | None
my $byte = "YmFzZSA2NCBkYXRh"; # string | None
my $integer = 56; # int | None
my $int32 = 56; # int | None
my $int64 = 789; # int | None
my $float = 3.4; # double | None
my $string = "string_example"; # string | None
my $binary = "/path/to/file"; # string | None
my $date = DateTime->from_epoch(epoch => str2time('null')); # DateTime | None
my $date_time = DateTime->from_epoch(epoch => str2time('null')); # DateTime | None
my $password = "password_example"; # string | None
my $callback = "callback_example"; # string | None

eval { 
    $api_instance->test_endpoint_parameters(number => $number, double => $double, pattern_without_delimiter => $pattern_without_delimiter, byte => $byte, integer => $integer, int32 => $int32, int64 => $int64, float => $float, string => $string, binary => $binary, date => $date, date_time => $date_time, password => $password, callback => $callback);
};
if ($@) {
    warn "Exception when calling FakeApi->test_endpoint_parameters: $@\n";
}

Parameters

Name	Type	Description	Notes
number	double	None
double	double	None
pattern_without_delimiter	string	None
byte	string	None
integer	int	None	[optional]
int32	int	None	[optional]
int64	int	None	[optional]
float	double	None	[optional]
string	string	None	[optional]
binary	string****string	None	[optional]
date	DateTime	None	[optional]
date_time	DateTime	None	[optional]
password	string	None	[optional]
callback	string	None	[optional]

Return type

void (empty response body)

Authorization

http_basic_test

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

test_enum_parameters

test_enum_parameters(enum_header_string_array => $enum_header_string_array, enum_header_string => $enum_header_string, enum_query_string_array => $enum_query_string_array, enum_query_string => $enum_query_string, enum_query_integer => $enum_query_integer, enum_query_double => $enum_query_double, enum_form_string_array => $enum_form_string_array, enum_form_string => $enum_form_string)

To test enum parameters

To test enum parameters

Example

use Data::Dumper;
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
);

my $enum_header_string_array = [("'$'")]; # ARRAY[string] | Header parameter enum test (string array)
my $enum_header_string = '-efg'; # string | Header parameter enum test (string)
my $enum_query_string_array = [("'$'")]; # ARRAY[string] | Query parameter enum test (string array)
my $enum_query_string = '-efg'; # string | Query parameter enum test (string)
my $enum_query_integer = 56; # int | Query parameter enum test (double)
my $enum_query_double = 3.4; # double | Query parameter enum test (double)
my $enum_form_string_array = ['$']; # ARRAY[string] | Form parameter enum test (string array)
my $enum_form_string = '-efg'; # string | Form parameter enum test (string)

eval { 
    $api_instance->test_enum_parameters(enum_header_string_array => $enum_header_string_array, enum_header_string => $enum_header_string, enum_query_string_array => $enum_query_string_array, enum_query_string => $enum_query_string, enum_query_integer => $enum_query_integer, enum_query_double => $enum_query_double, enum_form_string_array => $enum_form_string_array, enum_form_string => $enum_form_string);
};
if ($@) {
    warn "Exception when calling FakeApi->test_enum_parameters: $@\n";
}

Parameters

Name	Type	Description	Notes
enum_header_string_array	ARRAY[string]	Header parameter enum test (string array)	[optional]
enum_header_string	string	Header parameter enum test (string)	[optional] [default to '-efg']
enum_query_string_array	ARRAY[string]	Query parameter enum test (string array)	[optional]
enum_query_string	string	Query parameter enum test (string)	[optional] [default to '-efg']
enum_query_integer	int	Query parameter enum test (double)	[optional]
enum_query_double	double	Query parameter enum test (double)	[optional]
enum_form_string_array	ARRAY[string]	Form parameter enum test (string array)	[optional] [default to '$']
enum_form_string	string	Form parameter enum test (string)	[optional] [default to '-efg']

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

test_group_parameters

test_group_parameters(required_string_group => $required_string_group, required_boolean_group => $required_boolean_group, required_int64_group => $required_int64_group, string_group => $string_group, boolean_group => $boolean_group, int64_group => $int64_group)

Fake endpoint to test group parameters (optional)

Fake endpoint to test group parameters (optional)

Example

use Data::Dumper;
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
);

my $required_string_group = 56; # int | Required String in group parameters
my $required_boolean_group = null; # boolean | Required Boolean in group parameters
my $required_int64_group = 789; # int | Required Integer in group parameters
my $string_group = 56; # int | String in group parameters
my $boolean_group = null; # boolean | Boolean in group parameters
my $int64_group = 789; # int | Integer in group parameters

eval { 
    $api_instance->test_group_parameters(required_string_group => $required_string_group, required_boolean_group => $required_boolean_group, required_int64_group => $required_int64_group, string_group => $string_group, boolean_group => $boolean_group, int64_group => $int64_group);
};
if ($@) {
    warn "Exception when calling FakeApi->test_group_parameters: $@\n";
}

Parameters

Name	Type	Description	Notes
required_string_group	int	Required String in group parameters
required_boolean_group	boolean	Required Boolean in group parameters
required_int64_group	int	Required Integer in group parameters
string_group	int	String in group parameters	[optional]
boolean_group	boolean	Boolean in group parameters	[optional]
int64_group	int	Integer in group parameters	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

test_inline_additional_properties

test_inline_additional_properties(param => $param)

test inline additionalProperties

Example

use Data::Dumper;
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
);

my $param = WWW::OpenAPIClient::Object::HASH[string,string]->new(); # HASH[string,string] | request body

eval { 
    $api_instance->test_inline_additional_properties(param => $param);
};
if ($@) {
    warn "Exception when calling FakeApi->test_inline_additional_properties: $@\n";
}

Parameters

Name	Type	Description	Notes
param	HASH[string,string]	request body

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

test_json_form_data

test_json_form_data(param => $param, param2 => $param2)

test json serialization of form data

Example

use Data::Dumper;
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
);

my $param = "param_example"; # string | field1
my $param2 = "param2_example"; # string | field2

eval { 
    $api_instance->test_json_form_data(param => $param, param2 => $param2);
};
if ($@) {
    warn "Exception when calling FakeApi->test_json_form_data: $@\n";
}

Parameters

Name	Type	Description	Notes
param	string	field1
param2	string	field2

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

test_query_parameter_collection_format

test_query_parameter_collection_format(pipe => $pipe, ioutil => $ioutil, http => $http, url => $url, context => $context)

To test the collection format in query parameters

Example

use Data::Dumper;
use WWW::OpenAPIClient::FakeApi;
my $api_instance = WWW::OpenAPIClient::FakeApi->new(
);

my $pipe = [("null")]; # ARRAY[string] | 
my $ioutil = [("null")]; # ARRAY[string] | 
my $http = [("null")]; # ARRAY[string] | 
my $url = [("null")]; # ARRAY[string] | 
my $context = [("null")]; # ARRAY[string] | 

eval { 
    $api_instance->test_query_parameter_collection_format(pipe => $pipe, ioutil => $ioutil, http => $http, url => $url, context => $context);
};
if ($@) {
    warn "Exception when calling FakeApi->test_query_parameter_collection_format: $@\n";
}

Parameters

Name	Type	Description	Notes
pipe	ARRAY[string]
ioutil	ARRAY[string]
http	ARRAY[string]
url	ARRAY[string]
context	ARRAY[string]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]