README

This is a sample server Petstore server. For this sample, you can use the api key special-key to test the authorization filters.

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

Install from Packagist with Composer:

composer require iaybgu/petstore-sdk

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 Petstore\Client\Api\NoteApi(
    // 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()
);
$pet_note = new \Petstore\Client\Model\PetNote(); // \Petstore\Client\Model\PetNote

try {
    $result = $apiInstance->createNote($pet_note);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NoteApi->createNote: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

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

Class	Method	HTTP request	Description
NoteApi	createNote	POST /notes	Create a pet note
NoteApi	deleteNote	DELETE /notes/{id}	Delete a pet note
NoteApi	getNote	GET /notes/{id}	Get a pet note
NoteApi	updateNote	PUT /notes/{id}	Update a pet note
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
ReviewApi	createReview	POST /reviews	Create a pet review
ReviewApi	deleteReview	DELETE /reviews/{id}	Delete a pet review
ReviewApi	getReview	GET /reviews/{id}	Get a pet review
ReviewApi	updateReview	PUT /reviews/{id}	Update a pet review
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
WishlistApi	createWishlistItem	POST /wishlist	Save a pet
WishlistApi	deleteWishlistItem	DELETE /wishlist/{id}	Remove a saved pet
WishlistApi	getWishlistItem	GET /wishlist/{id}	Get a saved pet
WishlistApi	listWishlistItems	GET /wishlist	List saved pets
WishlistApi	updateWishlistItem	PUT /wishlist/{id}	Update a saved pet

Models

Authorization

Authentication schemes defined for the API:

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

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.25.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

iaybgu / petstore-sdk

Package info

Security

Statistics