This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: " \

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "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');

Getting Started

Please follow the installation procedure and then run the following:

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




$apiInstance = new OpenAPI\Client\Api\AnotherFakeApi(
    // 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->call123TestSpecialTags($client);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnotherFakeApi->call123TestSpecialTags: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to http://petstore.swagger.io:80/v2

Class	Method	HTTP request	Description
AnotherFakeApi	call123TestSpecialTags	PATCH /another-fake/dummy	To test special tags
DefaultApi	fooGet	GET /foo
FakeApi	fakeBigDecimalMap	GET /fake/BigDecimalMap
FakeApi	fakeEnumEndpoint	GET /fake/enum/endpoint	test endpoint with enum parameter
FakeApi	fakeHealthGet	GET /fake/health	Health check endpoint
FakeApi	fakeHttpSignatureTest	GET /fake/http-signature-test	test http signature authentication
FakeApi	fakeOuterBooleanSerialize	POST /fake/outer/boolean
FakeApi	fakeOuterCompositeSerialize	POST /fake/outer/composite
FakeApi	fakeOuterNumberSerialize	POST /fake/outer/number
FakeApi	fakeOuterStringSerialize	POST /fake/outer/string
FakeApi	fakePropertyEnumIntegerSerialize	POST /fake/property/enum-int
FakeApi	testAdditionalPropertiesReference	POST /fake/additionalProperties-reference	test referenced additionalProperties
FakeApi	testBodyWithBinary	PUT /fake/body-with-binary
FakeApi	testBodyWithFileSchema	PUT /fake/body-with-file-schema
FakeApi	testBodyWithQueryParams	PUT /fake/body-with-query-params
FakeApi	testClientModel	PATCH /fake	To test "client" model
FakeApi	testEndpointParameters	POST /fake	Fake endpoint for testing various parameters 假端點偽のエンドポイント 가짜 엔드 포인트
FakeApi	testEnumParameters	GET /fake	To test enum parameters
FakeApi	testGroupParameters	DELETE /fake	Fake endpoint to test group parameters (optional)
FakeApi	testInlineAdditionalProperties	POST /fake/inline-additionalProperties	test inline additionalProperties
FakeApi	testInlineFreeformAdditionalProperties	POST /fake/inline-freeform-additionalProperties	test inline free-form additionalProperties
FakeApi	testJsonFormData	GET /fake/jsonFormData	test json serialization of form data
FakeApi	testNullable	POST /fake/nullable	test nullable parent property
FakeApi	testQueryParameterCollectionFormat	PUT /fake/test-query-parameters
FakeApi	testStringMapReference	POST /fake/stringMap-reference	test referenced string map
FakeClassnameTags123Api	testClassname	PATCH /fake_classname_test	To test class name in snake case
PetApi	addPet	POST /pet	Add a new pet to the store
PetApi	deletePet	DELETE /pet/{petId}	Deletes a pet
PetApi	findPetsByStatus	GET /pet/findByStatus	Finds Pets by status
PetApi	findPetsByTags	GET /pet/findByTags	Finds Pets by tags
PetApi	getPetById	GET /pet/{petId}	Find pet by ID
PetApi	updatePet	PUT /pet	Update an existing pet
PetApi	updatePetWithForm	POST /pet/{petId}	Updates a pet in the store with form data
PetApi	uploadFile	POST /pet/{petId}/uploadImage	uploads an image
PetApi	uploadFileWithRequiredFile	POST /fake/{petId}/uploadImageWithRequiredFile	uploads an image (required)
StoreApi	deleteOrder	DELETE /store/order/{order_id}	Delete purchase order by ID
StoreApi	getInventory	GET /store/inventory	Returns pet inventories by status
StoreApi	getOrderById	GET /store/order/{order_id}	Find purchase order by ID
StoreApi	placeOrder	POST /store/order	Place an order for a pet
UserApi	createUser	POST /user	Create user
UserApi	createUsersWithArrayInput	POST /user/createWithArray	Creates list of users with given input array
UserApi	createUsersWithListInput	POST /user/createWithList	Creates list of users with given input array
UserApi	deleteUser	DELETE /user/{username}	Delete user
UserApi	getUserByName	GET /user/{username}	Get user by user name
UserApi	loginUser	GET /user/login	Logs user into the system
UserApi	logoutUser	GET /user/logout	Logs out current logged in user session
UserApi	updateUser	PUT /user/{username}	Updated user

Models

Authorization

petstore_auth

Type: OAuth
Flow: implicit
Authorization URL: http://petstore.swagger.io/api/oauth/dialog
Scopes:
- write:pets: modify pets in your account
- read:pets: read your pets

api_key

Type: API key
API key parameter name: api_key
Location: HTTP header

api_key_query

Type: API key
API key parameter name: api_key_query
Location: URL query string

http_basic_test

Type: HTTP basic authentication

bearer_test

Type: Bearer authentication (JWT)

http_signature_test

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
- Generator version: 7.11.0-SNAPSHOT
Build package: org.openapitools.codegen.languages.PhpNextgenClientCodegen