loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity
openapi-generator/samples/client/petstore/php/SwaggerClient-php
History
wing328 05a8c47a36 update docstring to include default value
2016-03-17 17:43:21 +08:00
..
docs
better hanlding of model name starting with number
2016-03-17 11:49:06 +08:00
lib
update docstring to include default value
2016-03-17 17:43:21 +08:00
tests
update php to handle object type and add more test case
2016-03-05 14:25:01 +08:00
.travis.yml
add .travis.yml
2016-02-20 21:54:00 +08:00
autoload.php
Update sample client
2015-06-18 11:43:48 -07:00
composer.json
add php documentation
2016-03-16 16:14:04 +08:00
git_push.sh
Regenerate PHP petstore sample
2016-03-16 13:08:09 +01:00
pom.xml
Code reformatting
2015-06-07 11:56:08 -04:00
README.md
update docstring to include default value
2016-03-17 17:43:21 +08:00

README.md

SwaggerClient-php

This is a sample server Petstore server. You can find out more about Swagger at <a href="http://swagger.io">http://swagger.io or on irc.freenode.net, #swagger. For this sample, you can use the api key "special-key" to test the authorization filters

This SDK is automatically generated by the Swagger Codegen project:

  • API verion: 1.0.0
  • Package version: 1.0.0
  • Build date: 2016-03-17T17:35:57.786+08:00
  • Build package: class io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

You can install the bindings via Composer. Add this to your composer.json:

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/YOUR_GIT_USR_ID/YOUR_GIT_REPO_ID.git"
    }
  ],
  "require": {
    "YOUR_GIT_USR_ID/YOUR_GIT_REPO_ID": "*@dev"
  }
}

Then install via composer install

Manual Installation

If you do not wish to use Composer, you can download the latest release. Then, to use the bindings, include the autoload.php file.

    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');

// Configure OAuth2 access token for authorization: petstore_auth
Swagger\Client::getDefaultConfiguration->setAccessToken('YOUR_ACCESS_TOKEN');

$api_instance = new Swagger\Client\PetApi();
$body = new \Swagger\Client\Model\Pet(); // \Swagger\Client\Model\Pet | Pet object that needs to be added to the store

try {
    $api_instance->addPet($body);
} catch (Exception $e) {
    echo 'Exception when calling PetApi->addPet: ', $e->getMessage(), "\n";
}

?>

Documentation for API Endpoints

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

Class Method HTTP request Description
PetApi addPet POST /pet Add a new pet to the store
PetApi addPetUsingByteArray POST /pet?testing_byte_array=true Fake endpoint to test byte array in body parameter for adding 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 getPetByIdInObject GET /pet/{petId}?response=inline_arbitrary_object Fake endpoint to test inline arbitrary object return by 'Find pet by ID'
PetApi petPetIdtestingByteArraytrueGet GET /pet/{petId}?testing_byte_array=true Fake endpoint to test byte array return by '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 findOrdersByStatus GET /store/findByStatus Finds orders by status
StoreApi getInventory GET /store/inventory Returns pet inventories by status
StoreApi getInventoryInObject GET /store/inventory?response=arbitrary_object Fake endpoint to test arbitrary object return by 'Get inventory'
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

Documentation For Authorization

test_api_key_header

  • Type: API key
  • API key parameter name: test_api_key_header
  • Location: HTTP header

api_key

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

test_http_basic

  • Type: HTTP basic authentication

test_api_client_secret

  • Type: API key
  • API key parameter name: x-test_api_client_secret
  • Location: HTTP header

test_api_client_id

  • Type: API key
  • API key parameter name: x-test_api_client_id
  • Location: HTTP header

test_api_key_query

  • Type: API key
  • API key parameter name: test_api_key_query
  • Location: URL query string

petstore_auth

Author

apiteam@swagger.io