loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

[php] use http_build_query for deepObject support (#11225)

Browse Source 
* Update ObjectSerializer::toQueryValue method

It looks a bit ugly right now, but at least all tests has been passed.

* Add tests of query serialization

I used fixtures from OpenAPISpec main doc. Some prop combinations are not
officially documented yet, for instance behavior for nested objects and
arrays.

* Add test fixture from @nadar

* Add tests of Guzzle query build failure

* Add query build wrapper static method

Co-authored-by: Yuriy Belenko <yura-bely@mail.ru>
This commit is contained in:
Basil
2022-03-22 10:56:15 +01:00
committed by GitHub
parent 36f0dd026c
commit 196b9f266f
12 changed files with 605 additions and 319 deletions
Download Patch File Download Diff File Expand all files Collapse all files

204
samples/client/petstore/php/OpenAPIClient-php/tests/ObjectSerializerTest.php
View File

@@ -130,4 +130,208 @@ class ObjectSerializerTest extends TestCase
],
];
}
/**
* @covers ObjectSerializer::toQueryValue
* @dataProvider provideQueryParams
*/
public function testToQueryValue(
$data,
string $paramName,
string $openApiType,
string $style,
bool $explode,
$expected
): void {
$value = ObjectSerializer::toQueryValue($data, $paramName, $openApiType, $style, $explode);
$query = ObjectSerializer::buildQuery($value);
$this->assertEquals($expected, $query);
}
public function provideQueryParams(): array
{
$array = ['blue', 'black', 'brown'];
$object = ['R' => 100, 'G' => 200, 'B' => 150];
return [
// style form
// color=
'form empty, explode on' => [
'', 'color', 'string', 'form', true, 'color=',
],
// color=
'form empty, explode off' => [
'', 'color', 'string', 'form', false, 'color=',
],
// color=blue
'form string, explode on' => [
'blue', 'color', 'string', 'form', true, 'color=blue',
],
// color=blue
'form string, explode off' => [
'blue', 'color', 'string', 'form', false, 'color=blue',
],
// color=blue&color=black&color=brown
'form array, explode on' => [
$array, 'color', 'array', 'form', true, 'color=blue&color=black&color=brown',
],
// color=blue&color=black&color=brown
'form nested array, explode on' => [
['foobar' => $array], 'color', 'array', 'form', true, 'color=blue&color=black&color=brown',
],
// color=blue,black,brown
'form array, explode off' => [
$array, 'color', 'array', 'form', false, 'color=blue%2Cblack%2Cbrown',
],
// color=blue,black,brown
'form nested array, explode off' => [
['foobar' => $array], 'color', 'array', 'form', false, 'color=blue%2Cblack%2Cbrown',
],
// R=100&G=200&B=150
'form object, explode on' => [
$object, 'color', 'object', 'form', true, 'R=100&G=200&B=150',
],
// color=R,100,G,200,B,150
'form object, explode off' => [
$object, 'color', 'object', 'form', false, 'color=R%2C100%2CG%2C200%2CB%2C150',
],
// SPACE DELIMITED
// color=blue
'spaceDelimited primitive, explode off' => [
'blue', 'color', 'string', 'spaceDelimited', false, 'color=blue',
],
// color=blue
'spaceDelimited primitive, explode on' => [
'blue', 'color', 'string', 'spaceDelimited', true, 'color=blue',
],
// color=blue%20black%20brown
'spaceDelimited array, explode off' => [
$array, 'color', 'array', 'spaceDelimited', false, 'color=blue%20black%20brown',
],
// color=blue&color=black&color=brown
'spaceDelimited array, explode on' => [
$array, 'color', 'array', 'spaceDelimited', true, 'color=blue&color=black&color=brown',
],
// color=R%20100%20G%20200%20B%20150
// swagger editor gives color=R,100,G,200,B,150
'spaceDelimited object, explode off' => [
$object, 'color', 'object', 'spaceDelimited', false, 'color=R%20100%20G%20200%20B%20150',
],
// R=100&G=200&B=150
'spaceDelimited object, explode on' => [
$object, 'color', 'object', 'spaceDelimited', true, 'R=100&G=200&B=150',
],
// PIPE DELIMITED
// color=blue
'pipeDelimited primitive, explode off' => [
'blue', 'color', 'string', 'pipeDelimited', false, 'color=blue',
],
// color=blue
'pipeDelimited primitive, explode on' => [
'blue', 'color', 'string', 'pipeDelimited', true, 'color=blue',
],
// color=blue|black|brown
'pipeDelimited array, explode off' => [
$array, 'color', 'array', 'pipeDelimited', false, 'color=blue%7Cblack%7Cbrown',
],
// color=blue&color=black&color=brown
'pipeDelimited array, explode on' => [
$array, 'color', 'array', 'pipeDelimited', true, 'color=blue&color=black&color=brown',
],
// color=R|100|G|200|B|150
// swagger editor gives color=R,100,G,200,B,150
'pipeDelimited object, explode off' => [
$object, 'color', 'object', 'pipeDelimited', false, 'color=R%7C100%7CG%7C200%7CB%7C150',
],
// R=100&G=200&B=150
'pipeDelimited object, explode on' => [
$object, 'color', 'object', 'pipeDelimited', true, 'R=100&G=200&B=150',
],
// DEEP OBJECT
// color=blue
'deepObject primitive, explode off' => [
'blue', 'color', 'string', 'deepObject', false, 'color=blue',
],
'deepObject primitive, explode on' => [
'blue', 'color', 'string', 'deepObject', true, 'color=blue',
],
// color=blue,black,brown
'deepObject array, explode off' => [
$array, 'color', 'array', 'deepObject', false, 'color=blue%2Cblack%2Cbrown',
],
// color=blue&color=black&color=brown
'deepObject array, explode on' => [
$array, 'color', 'array', 'deepObject', true, 'color=blue&color=black&color=brown',
],
// color[R]=100&color[G]=200&color[B]=150
'deepObject object, explode off' => [
$object, 'color', 'object', 'deepObject', false, 'color%5BR%5D=100&color%5BG%5D=200&color%5BB%5D=150',
],
// color[R]=100&color[G]=200&color[B]=150
'deepObject object, explode on' => [
$object, 'color', 'object', 'deepObject', true, 'color%5BR%5D=100&color%5BG%5D=200&color%5BB%5D=150',
],
// filter[or][0][name]=John&filter[or][1][email]=john@doe.com
'example from @nadar' => [
[
'or' =>
[
['name' => 'John'],
['email' => 'john@doe.com'],
],
],
'filter',
'object',
'deepObject',
true,
'filter%5Bor%5D%5B0%5D%5Bname%5D=John&filter%5Bor%5D%5B1%5D%5Bemail%5D=john%40doe.com'
],
];
}
/**
* @covers ObjectSerializer::toQueryValue
* @dataProvider provideDeepObjects
*/
public function testDeepObjectStyleQueryParam(
$data,
$paramName,
$expected
): void {
$value = ObjectSerializer::buildQuery(ObjectSerializer::toQueryValue($data, $paramName, 'object', 'deepObject', true));
parse_str($value, $result);
$this->assertEquals($expected, $result);
}
public function provideDeepObjects(): array
{
return [
/** example @see https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-examples */
'example OpenAPISpec doc' => [
['R' => 100, 'G' => 200, 'B' => 150],
'color',
[
'color' => [
'R' => 100,
'G' => 200,
'B' => 150,
],
],
],
/** example @see https://swagger.io/docs/specification/serialization/ */
'example Swagger doc' => [
['role' => 'admin', 'firstName' => 'Alex'],
'id',
[
'id' => [
'role' => 'admin',
'firstName' => 'Alex',
],
],
],
];
}
}