Skip to content

[PHP] - Add range HTTP code support #20992

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 6, 2025
Merged

[PHP] - Add range HTTP code support #20992

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a45d158
[PHP] - Add range HTTP code support
jtreminio Mar 29, 2025
a54b22d
Adding response body to 200
jtreminio Mar 29, 2025
b1623f7
Fix diff; update php-nextgen sample
jtreminio Mar 29, 2025
23bd142
Working on unit tests
jtreminio Mar 29, 2025
79cc0af
Removes dangling files
jtreminio Mar 29, 2025
e5b451d
Finalize tests
jtreminio Mar 29, 2025
313dbb8
Remove dangling files
jtreminio Mar 29, 2025
1c8493d
Add tests for no response body exception
jtreminio Mar 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
130 changes: 74 additions & 56 deletions modules/openapi-generator/src/main/resources/php-nextgen/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ use GuzzleHttp\Psr7\MultipartStream;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\RequestOptions;
use GuzzleHttp\Promise\PromiseInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use {{invokerPackage}}\ApiException;
use {{invokerPackage}}\Configuration;
use {{invokerPackage}}\HeaderSelector;
Expand Down Expand Up @@ -289,42 +291,28 @@ use {{invokerPackage}}\ObjectSerializer;
{{#returnType}}
{{#responses}}
{{#-first}}

switch($statusCode) {
{{/-first}}
{{#dataType}}
{{^isRange}}{{^isWildcard}}case {{code}}:{{/isWildcard}}{{#isWildcard}}default:{{/isWildcard}}
if (in_array('{{{dataType}}}', ['\SplFileObject', '\Psr\Http\Message\StreamInterface'])) {
$content = $response->getBody(); //stream goes to serializer
} else {
$content = (string) $response->getBody();
if ('{{{dataType}}}' !== 'string') {
try {
$content = json_decode($content, false, 512, JSON_THROW_ON_ERROR);
} catch (\JsonException $exception) {
throw new ApiException(
sprintf(
'Error JSON decoding server response (%s)',
$request->getUri()
),
$statusCode,
$response->getHeaders(),
$content
);
}
}
}

return [
ObjectSerializer::deserialize($content, '{{{dataType}}}', []),
$response->getStatusCode(),
$response->getHeaders()
];{{/isRange}}
return $this->handleResponseWithDataType(
'{{{dataType}}}',
$request,
$response,
);{{/isRange}}
{{/dataType}}
{{#-last}}
}
{{/-last}}
{{/responses}}
{{#responses}}{{#dataType}}{{#isRange}}{{^isWildcard}}
if ($this->responseWithinRangeCode('{{code}}', $statusCode)) {
return $this->handleResponseWithDataType(
'{{{dataType}}}',
$request,
$response,
);
}{{/isWildcard}}{{/isRange}}{{/dataType}}{{/responses}}

if ($statusCode < 200 || $statusCode > 299) {
throw new ApiException(
Expand All @@ -339,39 +327,16 @@ use {{invokerPackage}}\ObjectSerializer;
);
}

$returnType = '{{{returnType}}}';
if (in_array($returnType, ['\SplFileObject', '\Psr\Http\Message\StreamInterface'])) {
$content = $response->getBody(); //stream goes to serializer
} else {
$content = (string) $response->getBody();
if ($returnType !== 'string') {
try {
$content = json_decode($content, false, 512, JSON_THROW_ON_ERROR);
} catch (\JsonException $exception) {
throw new ApiException(
sprintf(
'Error JSON decoding server response (%s)',
$request->getUri()
),
$statusCode,
$response->getHeaders(),
$content
);
}
}
}

return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
return $this->handleResponseWithDataType(
'{{{returnType}}}',
$request,
$response,
);
{{/returnType}}
{{^returnType}}

return [null, $statusCode, $response->getHeaders()];
{{/returnType}}

} catch (ApiException $e) {
switch ($e->getCode()) {
{{#responses}}
Expand All @@ -383,10 +348,20 @@ use {{invokerPackage}}\ObjectSerializer;
$e->getResponseHeaders()
);
$e->setResponseObject($data);
break;{{/isRange}}
throw $e;{{/isRange}}
{{/dataType}}
{{/responses}}
}
{{#responses}}{{#dataType}}{{#isRange}}{{^isWildcard}}
if ($this->responseWithinRangeCode('{{code}}', $e->getCode())) {
$data = ObjectSerializer::deserialize(
$e->getResponseBody(),
'{{{dataType}}}',
$e->getResponseHeaders()
);
$e->setResponseObject($data);
throw $e;
}{{/isWildcard}}{{/isRange}}{{/dataType}}{{/responses}}
throw $e;
}
}
Expand Down Expand Up @@ -938,5 +913,48 @@ use {{invokerPackage}}\ObjectSerializer;

return $options;
}

private function handleResponseWithDataType(
string $dataType,
RequestInterface $request,
ResponseInterface $response,
): array {
if (in_array($dataType, ['\SplFileObject', '\Psr\Http\Message\StreamInterface'])) {
$content = $response->getBody(); //stream goes to serializer
} else {
$content = (string) $response->getBody();
if ($dataType !== 'string') {
try {
$content = json_decode($content, false, 512, JSON_THROW_ON_ERROR);
} catch (\JsonException $exception) {
throw new ApiException(
sprintf(
'Error JSON decoding server response (%s)',
$request->getUri()
),
$response->getStatusCode(),
$response->getHeaders(),
$content
);
}
}
}

return [
ObjectSerializer::deserialize($content, $dataType, []),
$response->getStatusCode(),
$response->getHeaders()
];
}

private function responseWithinRangeCode(
string $rangeCode,
int $statusCode,
): bool {
$left = (int) ($rangeCode[0].'00');
$right = (int) ($rangeCode[0].'99');

return $statusCode >= $left && $statusCode <= $right;
}
}
{{/operations}}
130 changes: 75 additions & 55 deletions modules/openapi-generator/src/main/resources/php/api.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ use GuzzleHttp\Exception\RequestException;
use GuzzleHttp\Psr7\MultipartStream;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\RequestOptions;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use {{invokerPackage}}\ApiException;
use {{invokerPackage}}\Configuration;
use {{invokerPackage}}\HeaderSelector;
Expand Down Expand Up @@ -262,38 +264,25 @@ use {{invokerPackage}}\ObjectSerializer;
{{/-first}}
{{#dataType}}
{{^isRange}}{{^isWildcard}}case {{code}}:{{/isWildcard}}{{#isWildcard}}default:{{/isWildcard}}
if ('{{{dataType}}}' === '\SplFileObject') {
$content = $response->getBody(); //stream goes to serializer
} else {
$content = (string) $response->getBody();
if ('{{{dataType}}}' !== 'string') {
try {
$content = json_decode($content, false, 512, JSON_THROW_ON_ERROR);
} catch (\JsonException $exception) {
throw new ApiException(
sprintf(
'Error JSON decoding server response (%s)',
$request->getUri()
),
$statusCode,
$response->getHeaders(),
$content
);
}
}
}

return [
ObjectSerializer::deserialize($content, '{{{dataType}}}', []),
$response->getStatusCode(),
$response->getHeaders()
];{{/isRange}}
return $this->handleResponseWithDataType(
'{{{dataType}}}',
$request,
$response,
);{{/isRange}}
{{/dataType}}
{{#-last}}
}
{{/-last}}
{{/responses}}

{{#responses}}{{#dataType}}{{#isRange}}{{^isWildcard}}if ($this->responseWithinRangeCode('{{code}}', $statusCode)) {
return $this->handleResponseWithDataType(
'{{{dataType}}}',
$request,
$response,
);
}{{/isWildcard}}{{/isRange}}{{/dataType}}{{/responses}}

if ($statusCode < 200 || $statusCode > 299) {
throw new ApiException(
sprintf(
Expand All @@ -307,39 +296,16 @@ use {{invokerPackage}}\ObjectSerializer;
);
}

$returnType = '{{{returnType}}}';
if ($returnType === '\SplFileObject') {
$content = $response->getBody(); //stream goes to serializer
} else {
$content = (string) $response->getBody();
if ($returnType !== 'string') {
try {
$content = json_decode($content, false, 512, JSON_THROW_ON_ERROR);
} catch (\JsonException $exception) {
throw new ApiException(
sprintf(
'Error JSON decoding server response (%s)',
$request->getUri()
),
$statusCode,
$response->getHeaders(),
$content
);
}
}
}

return [
ObjectSerializer::deserialize($content, $returnType, []),
$response->getStatusCode(),
$response->getHeaders()
];
return $this->handleResponseWithDataType(
'{{{returnType}}}',
$request,
$response,
);
{{/returnType}}
{{^returnType}}

return [null, $statusCode, $response->getHeaders()];
{{/returnType}}

} catch (ApiException $e) {
switch ($e->getCode()) {
{{#responses}}
Expand All @@ -351,10 +317,21 @@ use {{invokerPackage}}\ObjectSerializer;
$e->getResponseHeaders()
);
$e->setResponseObject($data);
break;{{/isRange}}
throw $e;{{/isRange}}
{{/dataType}}
{{/responses}}
}
{{#responses}}{{#dataType}}{{#isRange}}{{^isWildcard}}
if ($this->responseWithinRangeCode('{{code}}', $e->getCode())) {
$data = ObjectSerializer::deserialize(
$e->getResponseBody(),
'{{{dataType}}}',
$e->getResponseHeaders()
);
$e->setResponseObject($data);
throw $e;
}{{/isWildcard}}{{/isRange}}{{/dataType}}{{/responses}}

throw $e;
}
}
Expand Down Expand Up @@ -859,5 +836,48 @@ use {{invokerPackage}}\ObjectSerializer;

return $options;
}

private function handleResponseWithDataType(
string $dataType,
RequestInterface $request,
ResponseInterface $response
): array {
if ($dataType === '\SplFileObject') {
$content = $response->getBody(); //stream goes to serializer
} else {
$content = (string) $response->getBody();
if ($dataType !== 'string') {
try {
$content = json_decode($content, false, 512, JSON_THROW_ON_ERROR);
} catch (\JsonException $exception) {
throw new ApiException(
sprintf(
'Error JSON decoding server response (%s)',
$request->getUri()
),
$response->getStatusCode(),
$response->getHeaders(),
$content
);
}
}
}

return [
ObjectSerializer::deserialize($content, $dataType, []),
$response->getStatusCode(),
$response->getHeaders()
];
}

private function responseWithinRangeCode(
string $rangeCode,
int $statusCode
): bool {
$left = (int) ($rangeCode[0].'00');
$right = (int) ($rangeCode[0].'99');

return $statusCode >= $left && $statusCode <= $right;
}
}
{{/operations}}
Loading
Loading