SwaggerClient-php
This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose.
This PHP package is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.0
- Build date: 2016-05-06T16:24:00.420+08:00
- Build package: class io.swagger.codegen.languages.PhpClientCodegen
Requirements
PHP 5.4.0 and later
Installation & Usage
Composer
To install the bindings via Composer, 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
:
require_once('/path/to/SwaggerClient-php/autoload.php');
Tests
To run the unit tests:
composer install
./vendor/bin/phpunit lib/Tests
Getting Started
Please follow the installation procedure and then run the following:
<?php
require_once(__DIR__ . '/vendor/autoload.php');
$api_instance = new Swagger\Client\Api\FakeApi();
$number = 3.4; // float | None
$double = 1.2; // double | None
$string = "string_example"; // string | None
$byte = "B"; // string | None
$integer = 56; // int | None
$int32 = 56; // int | None
$int64 = 789; // int | None
$float = 3.4; // float | None
$binary = "B"; // string | None
$date = new \DateTime(); // \DateTime | None
$date_time = new \DateTime(); // \DateTime | None
$password = "password_example"; // string | None
try {
$api_instance->testEndpointParameters($number, $double, $string, $byte, $integer, $int32, $int64, $float, $binary, $date, $date_time, $password);
} catch (Exception $e) {
echo 'Exception when calling FakeApi->testEndpointParameters: ', $e->getMessage(), "\n";
}
?>
Documentation for API Endpoints
All URIs are relative to http://petstore.swagger.io/v2
Class | Method | HTTP request | Description |
---|---|---|---|
FakeApi | testEndpointParameters | POST /fake | Fake endpoint for testing various parameters |
假端點 | |||
偽のエンドポイント | |||
가짜 엔드 포인트 |
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 StoreApi | deleteOrder | DELETE /store/order/{orderId} | Delete purchase order by ID StoreApi | getInventory | GET /store/inventory | Returns pet inventories by status StoreApi | getOrderById | GET /store/order/{orderId} | 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
Documentation For Models
- Animal
- AnimalFarm
- ApiResponse
- Cat
- Category
- Dog
- EnumClass
- EnumTest
- FormatTest
- Model200Response
- ModelReturn
- Name
- Order
- Pet
- SpecialModelName
- Tag
- User
Documentation For Authorization
api_key
- Type: API key
- API key parameter name: api_key
- 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
- read:pets: read your pets