Skip to content

Migrate PHP client samples to use OAS v3 spec #6722

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
wing328 merged 2 commits into from
Jun 22, 2020
Merged

Migrate PHP client samples to use OAS v3 spec #6722

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
60e8c56
consolidate php samples
wing328 Jun 20, 2020
eb664d7
restore EnumTestTest.php
wing328 Jun 20, 2020
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
4 changes: 0 additions & 4 deletions bin/configs/php-OpenAPIClient-oas2.yaml
View file
Open in desktop

This file was deleted.

2 changes: 1 addition & 1 deletion bin/configs/php-OpenAPIClient.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
generatorName: php
outputDir: samples/openapi3/client/petstore/php/OpenAPIClient-php
outputDir: samples/client/petstore/php/OpenAPIClient-php
inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml
templateDir: modules/openapi-generator/src/main/resources/php
1 change: 0 additions & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1194,7 +1194,6 @@
<module>samples/client/petstore/rust/reqwest/petstore</module>
<module>samples/client/petstore/rust/reqwest/petstore-async</module>
<module>samples/client/petstore/php/OpenAPIClient-php</module>
<module>samples/openapi3/client/petstore/php/OpenAPIClient-php</module>
<!--<module>samples/client/petstore/javascript-apollo</module>-->
<module>samples/client/petstore/javascript-es6</module>
<module>samples/client/petstore/javascript-promise-es6</module>
Expand Down
52 changes: 28 additions & 24 deletions samples/client/petstore/php/OpenAPIClient-php/.openapi-generator/FILES
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,18 @@
README.md
composer.json
docs/Api/AnotherFakeApi.md
docs/Api/DefaultApi.md
docs/Api/FakeApi.md
docs/Api/FakeClassnameTags123Api.md
docs/Api/PetApi.md
docs/Api/StoreApi.md
docs/Api/UserApi.md
docs/Model/AdditionalPropertiesAnyType.md
docs/Model/AdditionalPropertiesArray.md
docs/Model/AdditionalPropertiesBoolean.md
docs/Model/AdditionalPropertiesClass.md
docs/Model/AdditionalPropertiesInteger.md
docs/Model/AdditionalPropertiesNumber.md
docs/Model/AdditionalPropertiesObject.md
docs/Model/AdditionalPropertiesString.md
docs/Model/Animal.md
docs/Model/ApiResponse.md
docs/Model/ArrayOfArrayOfNumberOnly.md
docs/Model/ArrayOfNumberOnly.md
docs/Model/ArrayTest.md
docs/Model/BigCat.md
docs/Model/BigCatAllOf.md
docs/Model/Capitalization.md
docs/Model/Cat.md
docs/Model/CatAllOf.md
Expand All @@ -37,28 +29,39 @@ docs/Model/EnumClass.md
docs/Model/EnumTest.md
docs/Model/File.md
docs/Model/FileSchemaTestClass.md
docs/Model/Foo.md
docs/Model/FormatTest.md
docs/Model/HasOnlyReadOnly.md
docs/Model/HealthCheckResult.md
docs/Model/InlineObject.md
docs/Model/InlineObject1.md
docs/Model/InlineObject2.md
docs/Model/InlineObject3.md
docs/Model/InlineObject4.md
docs/Model/InlineObject5.md
docs/Model/InlineResponseDefault.md
docs/Model/MapTest.md
docs/Model/MixedPropertiesAndAdditionalPropertiesClass.md
docs/Model/Model200Response.md
docs/Model/ModelList.md
docs/Model/ModelReturn.md
docs/Model/Name.md
docs/Model/NullableClass.md
docs/Model/NumberOnly.md
docs/Model/Order.md
docs/Model/OuterComposite.md
docs/Model/OuterEnum.md
docs/Model/OuterEnumDefaultValue.md
docs/Model/OuterEnumInteger.md
docs/Model/OuterEnumIntegerDefaultValue.md
docs/Model/Pet.md
docs/Model/ReadOnlyFirst.md
docs/Model/SpecialModelName.md
docs/Model/Tag.md
docs/Model/TypeHolderDefault.md
docs/Model/TypeHolderExample.md
docs/Model/User.md
docs/Model/XmlItem.md
git_push.sh
lib/Api/AnotherFakeApi.php
lib/Api/DefaultApi.php
lib/Api/FakeApi.php
lib/Api/FakeClassnameTags123Api.php
lib/Api/PetApi.php
Expand All @@ -67,21 +70,12 @@ lib/Api/UserApi.php
lib/ApiException.php
lib/Configuration.php
lib/HeaderSelector.php
lib/Model/AdditionalPropertiesAnyType.php
lib/Model/AdditionalPropertiesArray.php
lib/Model/AdditionalPropertiesBoolean.php
lib/Model/AdditionalPropertiesClass.php
lib/Model/AdditionalPropertiesInteger.php
lib/Model/AdditionalPropertiesNumber.php
lib/Model/AdditionalPropertiesObject.php
lib/Model/AdditionalPropertiesString.php
lib/Model/Animal.php
lib/Model/ApiResponse.php
lib/Model/ArrayOfArrayOfNumberOnly.php
lib/Model/ArrayOfNumberOnly.php
lib/Model/ArrayTest.php
lib/Model/BigCat.php
lib/Model/BigCatAllOf.php
lib/Model/Capitalization.php
lib/Model/Cat.php
lib/Model/CatAllOf.php
Expand All @@ -95,26 +89,36 @@ lib/Model/EnumClass.php
lib/Model/EnumTest.php
lib/Model/File.php
lib/Model/FileSchemaTestClass.php
lib/Model/Foo.php
lib/Model/FormatTest.php
lib/Model/HasOnlyReadOnly.php
lib/Model/HealthCheckResult.php
lib/Model/InlineObject.php
lib/Model/InlineObject1.php
lib/Model/InlineObject2.php
lib/Model/InlineObject3.php
lib/Model/InlineObject4.php
lib/Model/InlineObject5.php
lib/Model/InlineResponseDefault.php
lib/Model/MapTest.php
lib/Model/MixedPropertiesAndAdditionalPropertiesClass.php
lib/Model/Model200Response.php
lib/Model/ModelInterface.php
lib/Model/ModelList.php
lib/Model/ModelReturn.php
lib/Model/Name.php
lib/Model/NullableClass.php
lib/Model/NumberOnly.php
lib/Model/Order.php
lib/Model/OuterComposite.php
lib/Model/OuterEnum.php
lib/Model/OuterEnumDefaultValue.php
lib/Model/OuterEnumInteger.php
lib/Model/OuterEnumIntegerDefaultValue.php
lib/Model/Pet.php
lib/Model/ReadOnlyFirst.php
lib/Model/SpecialModelName.php
lib/Model/Tag.php
lib/Model/TypeHolderDefault.php
lib/Model/TypeHolderExample.php
lib/Model/User.php
lib/Model/XmlItem.php
lib/ObjectSerializer.php
phpunit.xml.dist
47 changes: 31 additions & 16 deletions samples/client/petstore/php/OpenAPIClient-php/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,10 @@ $apiInstance = new OpenAPI\Client\Api\AnotherFakeApi(
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$body = new \OpenAPI\Client\Model\Client(); // \OpenAPI\Client\Model\Client | client model
$client = new \OpenAPI\Client\Model\Client(); // \OpenAPI\Client\Model\Client | client model

try {
$result = $apiInstance->call123TestSpecialTags($body);
$result = $apiInstance->call123TestSpecialTags($client);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AnotherFakeApi->call123TestSpecialTags: ', $e->getMessage(), PHP_EOL;
Expand All @@ -84,15 +84,17 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AnotherFakeApi* | [**call123TestSpecialTags**](docs/Api/AnotherFakeApi.md#call123testspecialtags) | **PATCH** /another-fake/dummy | To test special tags
*FakeApi* | [**createXmlItem**](docs/Api/FakeApi.md#createxmlitem) | **POST** /fake/create_xml_item | creates an XmlItem
*DefaultApi* | [**fooGet**](docs/Api/DefaultApi.md#fooget) | **GET** /foo |
*FakeApi* | [**fakeHealthGet**](docs/Api/FakeApi.md#fakehealthget) | **GET** /fake/health | Health check endpoint
*FakeApi* | [**fakeHttpSignatureTest**](docs/Api/FakeApi.md#fakehttpsignaturetest) | **GET** /fake/http-signature-test | test http signature authentication
*FakeApi* | [**fakeOuterBooleanSerialize**](docs/Api/FakeApi.md#fakeouterbooleanserialize) | **POST** /fake/outer/boolean |
*FakeApi* | [**fakeOuterCompositeSerialize**](docs/Api/FakeApi.md#fakeoutercompositeserialize) | **POST** /fake/outer/composite |
*FakeApi* | [**fakeOuterNumberSerialize**](docs/Api/FakeApi.md#fakeouternumberserialize) | **POST** /fake/outer/number |
*FakeApi* | [**fakeOuterStringSerialize**](docs/Api/FakeApi.md#fakeouterstringserialize) | **POST** /fake/outer/string |
*FakeApi* | [**testBodyWithFileSchema**](docs/Api/FakeApi.md#testbodywithfileschema) | **PUT** /fake/body-with-file-schema |
*FakeApi* | [**testBodyWithQueryParams**](docs/Api/FakeApi.md#testbodywithqueryparams) | **PUT** /fake/body-with-query-params |
*FakeApi* | [**testClientModel**](docs/Api/FakeApi.md#testclientmodel) | **PATCH** /fake | To test \&quot;client\&quot; model
*FakeApi* | [**testEndpointParameters**](docs/Api/FakeApi.md#testendpointparameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
*FakeApi* | [**testEndpointParameters**](docs/Api/FakeApi.md#testendpointparameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
*FakeApi* | [**testEnumParameters**](docs/Api/FakeApi.md#testenumparameters) | **GET** /fake | To test enum parameters
*FakeApi* | [**testGroupParameters**](docs/Api/FakeApi.md#testgroupparameters) | **DELETE** /fake | Fake endpoint to test group parameters (optional)
*FakeApi* | [**testInlineAdditionalProperties**](docs/Api/FakeApi.md#testinlineadditionalproperties) | **POST** /fake/inline-additionalProperties | test inline additionalProperties
Expand Down Expand Up @@ -124,21 +126,12 @@ Class | Method | HTTP request | Description

## Documentation For Models

- [AdditionalPropertiesAnyType](docs/Model/AdditionalPropertiesAnyType.md)
- [AdditionalPropertiesArray](docs/Model/AdditionalPropertiesArray.md)
- [AdditionalPropertiesBoolean](docs/Model/AdditionalPropertiesBoolean.md)
- [AdditionalPropertiesClass](docs/Model/AdditionalPropertiesClass.md)
- [AdditionalPropertiesInteger](docs/Model/AdditionalPropertiesInteger.md)
- [AdditionalPropertiesNumber](docs/Model/AdditionalPropertiesNumber.md)
- [AdditionalPropertiesObject](docs/Model/AdditionalPropertiesObject.md)
- [AdditionalPropertiesString](docs/Model/AdditionalPropertiesString.md)
- [Animal](docs/Model/Animal.md)
- [ApiResponse](docs/Model/ApiResponse.md)
- [ArrayOfArrayOfNumberOnly](docs/Model/ArrayOfArrayOfNumberOnly.md)
- [ArrayOfNumberOnly](docs/Model/ArrayOfNumberOnly.md)
- [ArrayTest](docs/Model/ArrayTest.md)
- [BigCat](docs/Model/BigCat.md)
- [BigCatAllOf](docs/Model/BigCatAllOf.md)
- [Capitalization](docs/Model/Capitalization.md)
- [Cat](docs/Model/Cat.md)
- [CatAllOf](docs/Model/CatAllOf.md)
Expand All @@ -152,26 +145,36 @@ Class | Method | HTTP request | Description
- [EnumTest](docs/Model/EnumTest.md)
- [File](docs/Model/File.md)
- [FileSchemaTestClass](docs/Model/FileSchemaTestClass.md)
- [Foo](docs/Model/Foo.md)
- [FormatTest](docs/Model/FormatTest.md)
- [HasOnlyReadOnly](docs/Model/HasOnlyReadOnly.md)
- [HealthCheckResult](docs/Model/HealthCheckResult.md)
- [InlineObject](docs/Model/InlineObject.md)
- [InlineObject1](docs/Model/InlineObject1.md)
- [InlineObject2](docs/Model/InlineObject2.md)
- [InlineObject3](docs/Model/InlineObject3.md)
- [InlineObject4](docs/Model/InlineObject4.md)
- [InlineObject5](docs/Model/InlineObject5.md)
- [InlineResponseDefault](docs/Model/InlineResponseDefault.md)
- [MapTest](docs/Model/MapTest.md)
- [MixedPropertiesAndAdditionalPropertiesClass](docs/Model/MixedPropertiesAndAdditionalPropertiesClass.md)
- [Model200Response](docs/Model/Model200Response.md)
- [ModelList](docs/Model/ModelList.md)
- [ModelReturn](docs/Model/ModelReturn.md)
- [Name](docs/Model/Name.md)
- [NullableClass](docs/Model/NullableClass.md)
- [NumberOnly](docs/Model/NumberOnly.md)
- [Order](docs/Model/Order.md)
- [OuterComposite](docs/Model/OuterComposite.md)
- [OuterEnum](docs/Model/OuterEnum.md)
- [OuterEnumDefaultValue](docs/Model/OuterEnumDefaultValue.md)
- [OuterEnumInteger](docs/Model/OuterEnumInteger.md)
- [OuterEnumIntegerDefaultValue](docs/Model/OuterEnumIntegerDefaultValue.md)
- [Pet](docs/Model/Pet.md)
- [ReadOnlyFirst](docs/Model/ReadOnlyFirst.md)
- [SpecialModelName](docs/Model/SpecialModelName.md)
- [Tag](docs/Model/Tag.md)
- [TypeHolderDefault](docs/Model/TypeHolderDefault.md)
- [TypeHolderExample](docs/Model/TypeHolderExample.md)
- [User](docs/Model/User.md)
- [XmlItem](docs/Model/XmlItem.md)


## Documentation For Authorization
Expand All @@ -198,13 +201,25 @@ Class | Method | HTTP request | Description



## bearer_test


- **Type**: Bearer authentication (JWT)



## http_basic_test


- **Type**: HTTP basic authentication



## http_signature_test




## petstore_auth


Expand Down
8 changes: 4 additions & 4 deletions samples/client/petstore/php/OpenAPIClient-php/docs/Api/AnotherFakeApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Method | HTTP request | Description

## call123TestSpecialTags

> \OpenAPI\Client\Model\Client call123TestSpecialTags($body)
> \OpenAPI\Client\Model\Client call123TestSpecialTags($client)

To test special tags

Expand All @@ -28,10 +28,10 @@ $apiInstance = new OpenAPI\Client\Api\AnotherFakeApi(
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client()
);
$body = new \OpenAPI\Client\Model\Client(); // \OpenAPI\Client\Model\Client | client model
$client = new \OpenAPI\Client\Model\Client(); // \OpenAPI\Client\Model\Client | client model

try {
$result = $apiInstance->call123TestSpecialTags($body);
$result = $apiInstance->call123TestSpecialTags($client);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling AnotherFakeApi->call123TestSpecialTags: ', $e->getMessage(), PHP_EOL;
Expand All @@ -44,7 +44,7 @@ try {

Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**\OpenAPI\Client\Model\Client**](../Model/Client.md)| client model |
**client** | [**\OpenAPI\Client\Model\Client**](../Model/Client.md)| client model |

### Return type

Expand Down
15 changes: 11 additions & 4 deletions samples/client/petstore/php/OpenAPIClient-php/docs/Api/DefaultApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,20 @@ Method | HTTP request | Description
[**fooGet**](DefaultApi.md#fooGet) | **GET** /foo |


# **fooGet**

## fooGet

> \OpenAPI\Client\Model\InlineResponseDefault fooGet()



### Example

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


$apiInstance = new OpenAPI\Client\Api\DefaultApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
Expand All @@ -33,6 +37,7 @@ try {
```

### Parameters

This endpoint does not need any parameter.

### Return type
Expand All @@ -45,8 +50,10 @@ No authorization required

### HTTP request headers

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

[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md)
[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints)
[[Back to Model list]](../../README.md#documentation-for-models)
[[Back to README]](../../README.md)

Loading