OpenAPI\Client\FakeApi

All URIs are relative to http://petstore.swagger.io:80/v2, except if the operation defines another base path.

Method	HTTP request	Description
fakeBigDecimalMap()	GET /fake/BigDecimalMap
fakeDeletePet()	DELETE /fake/pet/{pet_id}
fakeEnumEndpoint()	GET /fake/enum/endpoint	test endpoint with enum parameter
fakeHealthGet()	GET /fake/health	Health check endpoint
fakeHttpSignatureTest()	GET /fake/http-signature-test	test http signature authentication
fakeOuterBooleanSerialize()	POST /fake/outer/boolean
fakeOuterCompositeSerialize()	POST /fake/outer/composite
fakeOuterNumberSerialize()	POST /fake/outer/number
fakeOuterStringSerialize()	POST /fake/outer/string
fakePropertyEnumIntegerSerialize()	POST /fake/property/enum-int
fakeWith400And4xxRangeResponseEndpoint()	POST /fake/with_400_and_4xx_range_response/endpoint	test endpoint with 400 and 400-499 range response http code with dataType
fakeWith400And4xxRangeResponseNo4xxDatatypeEndpoint()	POST /fake/with_400_and_4xx_range_response_no_4xx_datatype/endpoint	test endpoint with 400 and 400-499 range response http code without dataType
fakeWith400ResponseEndpoint()	POST /fake/with_400_response/endpoint	test endpoint with 400 response http code with dataType
fakeWith4xxRangeResponseEndpoint()	POST /fake/with_4xx_range_response/endpoint	test endpoint with 400-499 range response http code with dataType
fakeWith4xxRangeResponseNo4xxDatatypeEndpoint()	POST /fake/with_4xx_range_response_no_4xx_datatype/endpoint	test endpoint with 400-499 range response http code without dataType
testAdditionalPropertiesReference()	POST /fake/additionalProperties-reference	test referenced additionalProperties
testBodyWithBinary()	PUT /fake/body-with-binary
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
testInlineFreeformAdditionalProperties()	POST /fake/inline-freeform-additionalProperties	test inline free-form additionalProperties
testJsonFormData()	GET /fake/jsonFormData	test json serialization of form data
testNullable()	POST /fake/nullable	test nullable parent property
testQueryParameterCollectionFormat()	PUT /fake/test-query-parameters
testStringMapReference()	POST /fake/stringMap-reference	test referenced string map

`fakeBigDecimalMap()`

fakeBigDecimalMap(): \OpenAPI\Client\Model\FakeBigDecimalMap200Response

for Java apache and Java native, test toUrlQueryString for maps with BegDecimal keys

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->fakeBigDecimalMap();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->fakeBigDecimalMap: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\FakeBigDecimalMap200Response

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]

`fakeDeletePet()`

fakeDeletePet($pet_id)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$pet_id = 'pet_id_example'; // string | The id of the pet to retrieve

try {
    $apiInstance->fakeDeletePet($pet_id);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->fakeDeletePet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pet_id	string	The id of the pet to retrieve

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`fakeEnumEndpoint()`

fakeEnumEndpoint($enum_class, $enum_class_array, $enum_class_map): \OpenAPI\Client\Model\EnumClass

test endpoint with enum parameter

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$enum_class = new \OpenAPI\Client\Model\\OpenAPI\Client\Model\EnumClass(); // \OpenAPI\Client\Model\EnumClass | enum class parameter
$enum_class_array = array(new \OpenAPI\Client\Model\\OpenAPI\Client\Model\EnumClass()); // \OpenAPI\Client\Model\EnumClass[] | enum class parameter
$enum_class_map = array('key' => new \OpenAPI\Client\Model\\OpenAPI\Client\Model\EnumClass()); // array<string,\OpenAPI\Client\Model\EnumClass> | enum class parameter

try {
    $result = $apiInstance->fakeEnumEndpoint($enum_class, $enum_class_array, $enum_class_map);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->fakeEnumEndpoint: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
enum_class	\OpenAPI\Client\Model\EnumClass	enum class parameter
enum_class_array	\OpenAPI\Client\Model\EnumClass[]	enum class parameter
enum_class_map	array<string,\OpenAPI\Client\Model\EnumClass>	enum class parameter

Return type

\OpenAPI\Client\Model\EnumClass

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`fakeHealthGet()`

fakeHealthGet(): \OpenAPI\Client\Model\HealthCheckResult

Health check endpoint

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->fakeHealthGet();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->fakeHealthGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\OpenAPI\Client\Model\HealthCheckResult

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

`fakeHttpSignatureTest()`

fakeHttpSignatureTest($pet, $query_1, $header_1)

test http signature authentication

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');




$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$pet = new \OpenAPI\Client\Model\Pet(); // \OpenAPI\Client\Model\Pet | Pet object that needs to be added to the store
$query_1 = 'query_1_example'; // string | query parameter
$header_1 = 'header_1_example'; // string | header parameter

try {
    $apiInstance->fakeHttpSignatureTest($pet, $query_1, $header_1);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->fakeHttpSignatureTest: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pet	\OpenAPI\Client\Model\Pet	Pet object that needs to be added to the store
query_1	string	query parameter	[optional]
header_1	string	header parameter	[optional]

Return type

void (empty response body)

Authorization

http_signature_test

HTTP request headers

Content-Type: application/json, application/xml
Accept: Not defined

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

`fakeOuterBooleanSerialize()`

fakeOuterBooleanSerialize($body): bool

Test serialization of outer boolean types

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = True; // bool | Input boolean as post body

try {
    $result = $apiInstance->fakeOuterBooleanSerialize($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->fakeOuterBooleanSerialize: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

bool

Authorization

No authorization required

HTTP request headers

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

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

`fakeOuterCompositeSerialize()`

fakeOuterCompositeSerialize($outer_composite): \OpenAPI\Client\Model\OuterComposite

Test serialization of object with outer number type

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$outer_composite = new \OpenAPI\Client\Model\OuterComposite(); // \OpenAPI\Client\Model\OuterComposite | Input composite as post body

try {
    $result = $apiInstance->fakeOuterCompositeSerialize($outer_composite);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->fakeOuterCompositeSerialize: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
outer_composite	\OpenAPI\Client\Model\OuterComposite	Input composite as post body	[optional]

Return type

\OpenAPI\Client\Model\OuterComposite

Authorization

No authorization required

HTTP request headers

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

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

`fakeOuterNumberSerialize()`

fakeOuterNumberSerialize($body): float

Test serialization of outer number types

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = 3.4; // float | Input number as post body

try {
    $result = $apiInstance->fakeOuterNumberSerialize($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->fakeOuterNumberSerialize: ', $e->getMessage(), PHP_EOL;
}

Parameters

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

Return type

float

Authorization

No authorization required

HTTP request headers

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

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

`fakeOuterStringSerialize()`

fakeOuterStringSerialize($body): string

Test serialization of outer string types

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = 'body_example'; // string | Input string as post body

try {
    $result = $apiInstance->fakeOuterStringSerialize($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->fakeOuterStringSerialize: ', $e->getMessage(), PHP_EOL;
}

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: application/json
Accept: */*

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

`fakePropertyEnumIntegerSerialize()`

fakePropertyEnumIntegerSerialize($outer_object_with_enum_property): \OpenAPI\Client\Model\OuterObjectWithEnumProperty

Test serialization of enum (int) properties with examples

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$outer_object_with_enum_property = new \OpenAPI\Client\Model\OuterObjectWithEnumProperty(); // \OpenAPI\Client\Model\OuterObjectWithEnumProperty | Input enum (int) as post body

try {
    $result = $apiInstance->fakePropertyEnumIntegerSerialize($outer_object_with_enum_property);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->fakePropertyEnumIntegerSerialize: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
outer_object_with_enum_property	\OpenAPI\Client\Model\OuterObjectWithEnumProperty	Input enum (int) as post body

Return type

\OpenAPI\Client\Model\OuterObjectWithEnumProperty

Authorization

No authorization required

HTTP request headers

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

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

`fakeWith400And4xxRangeResponseEndpoint()`

fakeWith400And4xxRangeResponseEndpoint($pet): \OpenAPI\Client\Model\Pet

test endpoint with 400 and 400-499 range response http code with dataType

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$pet = new \OpenAPI\Client\Model\Pet(); // \OpenAPI\Client\Model\Pet | Pet object that needs to be added to the store

try {
    $result = $apiInstance->fakeWith400And4xxRangeResponseEndpoint($pet);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->fakeWith400And4xxRangeResponseEndpoint: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pet	\OpenAPI\Client\Model\Pet	Pet object that needs to be added to the store

Return type

\OpenAPI\Client\Model\Pet

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json

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

`fakeWith400And4xxRangeResponseNo4xxDatatypeEndpoint()`

fakeWith400And4xxRangeResponseNo4xxDatatypeEndpoint($pet): \OpenAPI\Client\Model\Pet

test endpoint with 400 and 400-499 range response http code without dataType

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$pet = new \OpenAPI\Client\Model\Pet(); // \OpenAPI\Client\Model\Pet | Pet object that needs to be added to the store

try {
    $result = $apiInstance->fakeWith400And4xxRangeResponseNo4xxDatatypeEndpoint($pet);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->fakeWith400And4xxRangeResponseNo4xxDatatypeEndpoint: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pet	\OpenAPI\Client\Model\Pet	Pet object that needs to be added to the store

Return type

\OpenAPI\Client\Model\Pet

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json

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

`fakeWith400ResponseEndpoint()`

fakeWith400ResponseEndpoint($pet): \OpenAPI\Client\Model\Pet

test endpoint with 400 response http code with dataType

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$pet = new \OpenAPI\Client\Model\Pet(); // \OpenAPI\Client\Model\Pet | Pet object that needs to be added to the store

try {
    $result = $apiInstance->fakeWith400ResponseEndpoint($pet);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->fakeWith400ResponseEndpoint: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pet	\OpenAPI\Client\Model\Pet	Pet object that needs to be added to the store

Return type

\OpenAPI\Client\Model\Pet

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json

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

`fakeWith4xxRangeResponseEndpoint()`

fakeWith4xxRangeResponseEndpoint($pet): \OpenAPI\Client\Model\Pet

test endpoint with 400-499 range response http code with dataType

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$pet = new \OpenAPI\Client\Model\Pet(); // \OpenAPI\Client\Model\Pet | Pet object that needs to be added to the store

try {
    $result = $apiInstance->fakeWith4xxRangeResponseEndpoint($pet);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->fakeWith4xxRangeResponseEndpoint: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pet	\OpenAPI\Client\Model\Pet	Pet object that needs to be added to the store

Return type

\OpenAPI\Client\Model\Pet

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json

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

`fakeWith4xxRangeResponseNo4xxDatatypeEndpoint()`

fakeWith4xxRangeResponseNo4xxDatatypeEndpoint($pet): \OpenAPI\Client\Model\Pet

test endpoint with 400-499 range response http code without dataType

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$pet = new \OpenAPI\Client\Model\Pet(); // \OpenAPI\Client\Model\Pet | Pet object that needs to be added to the store

try {
    $result = $apiInstance->fakeWith4xxRangeResponseNo4xxDatatypeEndpoint($pet);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->fakeWith4xxRangeResponseNo4xxDatatypeEndpoint: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
pet	\OpenAPI\Client\Model\Pet	Pet object that needs to be added to the store

Return type

\OpenAPI\Client\Model\Pet

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/xml
Accept: application/json

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

`testAdditionalPropertiesReference()`

testAdditionalPropertiesReference($request_body)

test referenced additionalProperties

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$request_body = NULL; // array<string,mixed> | request body

try {
    $apiInstance->testAdditionalPropertiesReference($request_body);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->testAdditionalPropertiesReference: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
request_body	array<string,mixed>	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]

`testBodyWithBinary()`

testBodyWithBinary($body)

For this test, the body has to be a binary file.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$body = '/path/to/file.txt'; // \SplFileObject | image to upload

try {
    $apiInstance->testBodyWithBinary($body);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->testBodyWithBinary: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
body	\SplFileObject\SplFileObject	image to upload

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: image/png
Accept: Not defined

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

`testBodyWithFileSchema()`

testBodyWithFileSchema($file_schema_test_class)

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$file_schema_test_class = new \OpenAPI\Client\Model\FileSchemaTestClass(); // \OpenAPI\Client\Model\FileSchemaTestClass

try {
    $apiInstance->testBodyWithFileSchema($file_schema_test_class);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->testBodyWithFileSchema: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
file_schema_test_class	\OpenAPI\Client\Model\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]

`testBodyWithQueryParams()`

testBodyWithQueryParams($query, $user)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$query = 'query_example'; // string
$user = new \OpenAPI\Client\Model\User(); // \OpenAPI\Client\Model\User

try {
    $apiInstance->testBodyWithQueryParams($query, $user);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->testBodyWithQueryParams: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
query	string
user	\OpenAPI\Client\Model\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]

`testClientModel()`

testClientModel($client): \OpenAPI\Client\Model\Client

To test "client" model

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$client = new \OpenAPI\Client\Model\Client(); // \OpenAPI\Client\Model\Client | client model

try {
    $result = $apiInstance->testClientModel($client);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->testClientModel: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
client	\OpenAPI\Client\Model\Client	client model

Return type

\OpenAPI\Client\Model\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]

`testEndpointParameters()`

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

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

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: http_basic_test
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$number = 3.4; // float | None
$double = 3.4; // float | None
$pattern_without_delimiter = 'pattern_without_delimiter_example'; // string | None
$byte = 'byte_example'; // string | None
$integer = 56; // int | None
$int32 = 56; // int | None
$int64 = 56; // int | None
$float = 3.4; // float | None
$string = 'string_example'; // string | None
$binary = '/path/to/file.txt'; // \SplFileObject | None
$date = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | None
$date_time = new \DateTime('2013-10-20T19:20:30+01:00'); // \DateTime | None
$password = 'password_example'; // string | None
$callback = 'callback_example'; // string | None

try {
    $apiInstance->testEndpointParameters($number, $double, $pattern_without_delimiter, $byte, $integer, $int32, $int64, $float, $string, $binary, $date, $date_time, $password, $callback);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->testEndpointParameters: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
number	float	None
double	float	None
pattern_without_delimiter	string	None
byte	string	None
integer	int	None	[optional]
int32	int	None	[optional]
int64	int	None	[optional]
float	float	None	[optional]
string	string	None	[optional]
binary	\SplFileObject\SplFileObject	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]

`testEnumParameters()`

testEnumParameters($enum_header_string_array, $enum_header_string, $enum_query_string_array, $enum_query_string, $enum_query_integer, $enum_query_double, $enum_query_model_array, $enum_form_string_array, $enum_form_string)

To test enum parameters

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$enum_header_string_array = ['$']; // string[] | Header parameter enum test (string array)
$enum_header_string = '-efg'; // string | Header parameter enum test (string)
$enum_query_string_array = ['$']; // string[] | Query parameter enum test (string array)
$enum_query_string = '-efg'; // string | Query parameter enum test (string)
$enum_query_integer = 56; // int | Query parameter enum test (double)
$enum_query_double = 3.4; // float | Query parameter enum test (double)
$enum_query_model_array = array(new \OpenAPI\Client\Model\\OpenAPI\Client\Model\EnumClass()); // \OpenAPI\Client\Model\EnumClass[]
$enum_form_string_array = ['$']; // string[] | Form parameter enum test (string array)
$enum_form_string = '-efg'; // string | Form parameter enum test (string)

try {
    $apiInstance->testEnumParameters($enum_header_string_array, $enum_header_string, $enum_query_string_array, $enum_query_string, $enum_query_integer, $enum_query_double, $enum_query_model_array, $enum_form_string_array, $enum_form_string);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->testEnumParameters: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
enum_header_string_array	string[]	Header parameter enum test (string array)	[optional] [default to ['$']]
enum_header_string	string	Header parameter enum test (string)	[optional] [default to '-efg']
enum_query_string_array	string[]	Query parameter enum test (string array)	[optional] [default to ['$']]
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	float	Query parameter enum test (double)	[optional]
enum_query_model_array	\OpenAPI\Client\Model\EnumClass[]		[optional]
enum_form_string_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]

`testGroupParameters()`

testGroupParameters($required_string_group, $required_boolean_group, $required_int64_group, $string_group, $boolean_group, $int64_group)

Fake endpoint to test group parameters (optional)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: bearer_test
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

$associative_array = [
    'required_string_group' => 56, // int | Required String in group parameters
    'required_boolean_group' => True, // bool | Required Boolean in group parameters
    'required_int64_group' => 56, // int | Required Integer in group parameters
    'string_group' => 56, // int | String in group parameters
    'boolean_group' => True, // bool | Boolean in group parameters
    'int64_group' => 56, // int | Integer in group parameters
];

try {
    $apiInstance->testGroupParameters($associate_array);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->testGroupParameters: ', $e->getMessage(), PHP_EOL;
}

Parameters

Note: the input parameter is an associative array with the keys listed as the parameter names below.

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

Return type

void (empty response body)

Authorization

bearer_test

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

`testInlineAdditionalProperties()`

testInlineAdditionalProperties($request_body)

test inline additionalProperties

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$request_body = array('key' => 'request_body_example'); // array<string,string> | request body

try {
    $apiInstance->testInlineAdditionalProperties($request_body);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->testInlineAdditionalProperties: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
request_body	array<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]

`testInlineFreeformAdditionalProperties()`

testInlineFreeformAdditionalProperties($test_inline_freeform_additional_properties_request)

test inline free-form additionalProperties

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$test_inline_freeform_additional_properties_request = new \OpenAPI\Client\Model\TestInlineFreeformAdditionalPropertiesRequest(); // \OpenAPI\Client\Model\TestInlineFreeformAdditionalPropertiesRequest | request body

try {
    $apiInstance->testInlineFreeformAdditionalProperties($test_inline_freeform_additional_properties_request);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->testInlineFreeformAdditionalProperties: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
test_inline_freeform_additional_properties_request	\OpenAPI\Client\Model\TestInlineFreeformAdditionalPropertiesRequest	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]

`testJsonFormData()`

testJsonFormData($param, $param2)

test json serialization of form data

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$param = 'param_example'; // string | field1
$param2 = 'param2_example'; // string | field2

try {
    $apiInstance->testJsonFormData($param, $param2);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->testJsonFormData: ', $e->getMessage(), PHP_EOL;
}

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]

`testNullable()`

testNullable($child_with_nullable)

test nullable parent property

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$child_with_nullable = new \OpenAPI\Client\Model\ChildWithNullable(); // \OpenAPI\Client\Model\ChildWithNullable | request body

try {
    $apiInstance->testNullable($child_with_nullable);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->testNullable: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
child_with_nullable	\OpenAPI\Client\Model\ChildWithNullable	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]

`testQueryParameterCollectionFormat()`

testQueryParameterCollectionFormat($pipe, $ioutil, $http, $url, $context, $allow_empty, $language)

To test the collection format in query parameters

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$pipe = array('pipe_example'); // string[]
$ioutil = array('ioutil_example'); // string[]
$http = array('http_example'); // string[]
$url = array('url_example'); // string[]
$context = array('context_example'); // string[]
$allow_empty = 'allow_empty_example'; // string
$language = array('key' => 'language_example'); // array<string,string>

try {
    $apiInstance->testQueryParameterCollectionFormat($pipe, $ioutil, $http, $url, $context, $allow_empty, $language);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->testQueryParameterCollectionFormat: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Notes
pipe	string[]
ioutil	string[]
http	string[]
url	string[]
context	string[]
allow_empty	string
language	array<string,string>	[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]

`testStringMapReference()`

testStringMapReference($request_body)

test referenced string map

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');



$apiInstance = new OpenAPI\Client\Api\FakeApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$request_body = array('key' => 'request_body_example'); // array<string,string> | request body

try {
    $apiInstance->testStringMapReference($request_body);
} catch (Exception $e) {
    echo 'Exception when calling FakeApi->testStringMapReference: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
request_body	array<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]

Uh oh!

FilesExpand file tree

FakeApi.md

Latest commit

History

FakeApi.md

File metadata and controls

OpenAPI\Client\FakeApi

fakeBigDecimalMap()

Example

Parameters

Return type

Authorization

HTTP request headers

fakeDeletePet()

Example

Parameters

Return type

Authorization

HTTP request headers

fakeEnumEndpoint()

Example

Parameters

Return type

Authorization

HTTP request headers

fakeHealthGet()

Example

Parameters

Return type

Authorization

HTTP request headers

fakeHttpSignatureTest()

Example

Parameters

Return type

Authorization

HTTP request headers

fakeOuterBooleanSerialize()

Example

Parameters

Return type

Authorization

HTTP request headers

fakeOuterCompositeSerialize()

Example

Parameters

Return type

Authorization

HTTP request headers

fakeOuterNumberSerialize()

Example

Parameters

Return type

Authorization

HTTP request headers

fakeOuterStringSerialize()

Example

Parameters

Return type

Authorization

HTTP request headers

fakePropertyEnumIntegerSerialize()

Example

Parameters

Return type

Authorization

HTTP request headers

fakeWith400And4xxRangeResponseEndpoint()

Example

Parameters

Return type

Authorization

HTTP request headers

fakeWith400And4xxRangeResponseNo4xxDatatypeEndpoint()

Example

Parameters

Return type

Authorization

HTTP request headers

`fakeBigDecimalMap()`

`fakeDeletePet()`

`fakeEnumEndpoint()`

`fakeHealthGet()`

`fakeHttpSignatureTest()`

`fakeOuterBooleanSerialize()`

`fakeOuterCompositeSerialize()`

`fakeOuterNumberSerialize()`

`fakeOuterStringSerialize()`

`fakePropertyEnumIntegerSerialize()`

`fakeWith400And4xxRangeResponseEndpoint()`

`fakeWith400And4xxRangeResponseNo4xxDatatypeEndpoint()`

`fakeWith400ResponseEndpoint()`

`fakeWith4xxRangeResponseEndpoint()`

`fakeWith4xxRangeResponseNo4xxDatatypeEndpoint()`

`testAdditionalPropertiesReference()`

`testBodyWithBinary()`

`testBodyWithFileSchema()`

`testBodyWithQueryParams()`

`testClientModel()`

`testEndpointParameters()`

`testEnumParameters()`

`testGroupParameters()`