forked from loafle/openapi-generator-original
a8cbae4dc8
* upgrade php-cs-fixer to 2.12 * ran petstore-security-test for php * updating openapi3 php petstore example
113 lines
2.8 KiB
Markdown
113 lines
2.8 KiB
Markdown
# OpenAPIClient-php
|
|
This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ *_/ ' \" =end --
|
|
|
|
This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
|
|
- API version: 1.0.0 *_/ ' \" =end -- \\r\\n \\n \\r
|
|
- Build package: org.openapitools.codegen.languages.PhpClientCodegen
|
|
|
|
## Requirements
|
|
|
|
PHP 5.5 and later
|
|
|
|
## Installation & Usage
|
|
### Composer
|
|
|
|
To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`:
|
|
|
|
```
|
|
{
|
|
"repositories": [
|
|
{
|
|
"type": "git",
|
|
"url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
|
|
}
|
|
],
|
|
"require": {
|
|
"GIT_USER_ID/GIT_REPO_ID": "*@dev"
|
|
}
|
|
}
|
|
```
|
|
|
|
Then run `composer install`
|
|
|
|
### Manual Installation
|
|
|
|
Download the files and include `autoload.php`:
|
|
|
|
```php
|
|
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');
|
|
```
|
|
|
|
## Tests
|
|
|
|
To run the unit tests:
|
|
|
|
```
|
|
composer install
|
|
./vendor/bin/phpunit
|
|
```
|
|
|
|
## Getting Started
|
|
|
|
Please follow the [installation procedure](#installation--usage) and then run the following:
|
|
|
|
```php
|
|
<?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()
|
|
);
|
|
$unknown_base_type = new \OpenAPI\Client\Model\UNKNOWN_BASE_TYPE(); // \OpenAPI\Client\Model\UNKNOWN_BASE_TYPE |
|
|
|
|
try {
|
|
$apiInstance->testCodeInjectEndRnNR($unknown_base_type);
|
|
} catch (Exception $e) {
|
|
echo 'Exception when calling FakeApi->testCodeInjectEndRnNR: ', $e->getMessage(), PHP_EOL;
|
|
}
|
|
|
|
?>
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *http://petstore.swagger.io *_/ ' \" =end -- \\r\\n \\n \\r/v2 *_/ ' \" =end -- \\r\\n \\n \\r*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*FakeApi* | [**testCodeInjectEndRnNR**](docs/Api/FakeApi.md#testcodeinjectendrnnr) | **PUT** /fake | To test code injection *_/ ' \" =end -- \\r\\n \\n \\r
|
|
|
|
|
|
## Documentation For Models
|
|
|
|
- [ModelReturn](docs/Model/ModelReturn.md)
|
|
|
|
|
|
## Documentation For Authorization
|
|
|
|
|
|
## api_key
|
|
|
|
- **Type**: API key
|
|
- **API key parameter name**: api_key */ ' " =end -- \r\n \n \r
|
|
- **Location**: HTTP header
|
|
|
|
## petstore_auth
|
|
|
|
- **Type**: OAuth
|
|
- **Flow**: implicit
|
|
- **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog
|
|
- **Scopes**:
|
|
- **write:pets**: modify pets in your account *_/ ' \" =end -- \\r\\n \\n \\r
|
|
- **read:pets**: read your pets *_/ ' \" =end -- \\r\\n \\n \\r
|
|
|
|
|
|
## Author
|
|
|
|
something@something.abc *_/ ' \" =end -- \\r\\n \\n \\r
|
|
|
|
|