v1.0.0

Swagger Petstore

My lovely API

This is a sample server Petstore server.
You can find out more about Swagger at
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.

Introduction

This API is documented in OpenAPI format and is based on
Petstore sample provided by swagger.io team.
It was extended to illustrate features of generator-openapi-repo
tool and ReDoc documentation. In addition to standard
OpenAPI syntax we use a few vendor extensions.

OpenAPI Specification

Cross-Origin Resource Sharing

This API features Cross-Origin Resource Sharing (CORS) implemented in compliance with W3C spec.
And that allows cross-domain communication from the browser.
All responses have a wildcard same-origin which makes them completely public and accessible to everyone, including any code on any site.

Authentication

Petstore offers two forms of authentication:

API Key
OAuth2
OAuth2 - an open protocol to allow secure authorization in a simple
and standard method from web, mobile and desktop applications.

Contact

API Support/apiteam@swagger.io

Terms of Service

http://swagger.io/terms/

License

Apache 2.0

External Documentation

Find out how to create Github repo for your OpenAPI spec.

Servers

//petstore.swagger.io/v2Default server

//petstore.swagger.io/sandboxSandbox server

pet

Everything about your Pets

Operations

GET/pet POST/pet PUT/pet DELETE/pet GET/pet/{petId}POST/pet/{petId}DELETE/pet/{petId}POST/pet/{petId}/uploadImage GET/pet/findByStatus GET/pet/findByTags

ID: delete\PetById

OperationId with backslash

pet

GET

/pet

Server

GET

/pet

Server

Samples

Bruno

get {
  url: //petstore.swagger.io/v2/pet
}

headers {
  Content-Type: application/json
}

Bruno

get {
  url: //petstore.swagger.io/v2/pet
}

headers {
  Content-Type: application/json
}

cURL

curl -X GET \
'//petstore.swagger.io/v2/pet' \
 -H "Content-Type: application/json"

JavaScript

fetch('//petstore.swagger.io/v2/pet', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/pet';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/pet'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

ID: addPet

Add a new pet to the store

pet

POST

/pet

Server

Add new pet to the store inventory.

Authorizations

petstore_auth

Get access to data while protecting your account credentials.
OAuth2 is also a safer and more secure way to give you access.

implicit Flow:

Authorization URL: http://petstore.swagger.io/api/oauth/dialogToken URL:

Scopes:

write:pets: modify pets in your account
read:pets: read your pets

Request Body

JSON

{

"id": 0,

"category": {

"id": 0,

"name": "string",

"sub": {

"prop1": "string"

}

"name": "Guru",

"photoUrls": "string",

"friend": "[Circular Reference]",

"tags": [

{

"id": 0,

"name": "string"

}

"status": "string",

"petType": "string",

"huntingSkill": {

}

Responses

Invalid input

POST

/pet

Server

Samples

Bruno

post {
  url: //petstore.swagger.io/v2/pet
}

headers {
  Content-Type: application/json
}

Bruno

post {
  url: //petstore.swagger.io/v2/pet
}

headers {
  Content-Type: application/json
}

cURL

curl -X POST \
'//petstore.swagger.io/v2/pet' \
 -H "Content-Type: application/json"

JavaScript

fetch('//petstore.swagger.io/v2/pet', {method:'POST',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/pet';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/pet'

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())

ID: updatePet

Update an existing pet

pet

PUT

/pet

Server

Authorizations

petstore_auth

Get access to data while protecting your account credentials.
OAuth2 is also a safer and more secure way to give you access.

implicit Flow:

Authorization URL: http://petstore.swagger.io/api/oauth/dialogToken URL:

Scopes:

write:pets: modify pets in your account
read:pets: read your pets

Request Body

JSON

{

"id": 0,

"category": {

"id": 0,

"name": "string",

"sub": {

"prop1": "string"

}

"name": "Guru",

"photoUrls": "string",

"friend": "[Circular Reference]",

"tags": [

{

"id": 0,

"name": "string"

}

"status": "string",

"petType": "string",

"huntingSkill": {

}

Responses

Invalid ID supplied

PUT

/pet

Server

Samples

Bruno

put {
  url: //petstore.swagger.io/v2/pet
}

headers {
  Content-Type: application/json
}

Bruno

put {
  url: //petstore.swagger.io/v2/pet
}

headers {
  Content-Type: application/json
}

cURL

curl -X PUT \
'//petstore.swagger.io/v2/pet' \
 -H "Content-Type: application/json"

JavaScript

fetch('//petstore.swagger.io/v2/pet', {method:'PUT',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/pet';
$method = 'PUT';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/pet'

headers = {
    'Content-Type': 'application/json'
}

response = requests.put(url, headers=headers)
print(response.json())

ID: deletePetBy"Id

OperationId with quotes

pet

DELETE

/pet

Server

DELETE

/pet

Server

Samples

Bruno

delete {
  url: //petstore.swagger.io/v2/pet
}

headers {
  Content-Type: application/json
}

Bruno

delete {
  url: //petstore.swagger.io/v2/pet
}

headers {
  Content-Type: application/json
}

cURL

curl -X DELETE \
'//petstore.swagger.io/v2/pet' \
 -H "Content-Type: application/json"

JavaScript

fetch('//petstore.swagger.io/v2/pet', {method:'DELETE',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/pet';
$method = 'DELETE';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/pet'

headers = {
    'Content-Type': 'application/json'
}

response = requests.delete(url, headers=headers)
print(response.json())

ID: getPetById

Find pet by ID

pet

GET

/pet/{petId}

Server

Returns a single pet

Authorizations

api_key

For this sample, you can use the api key special-key to test the authorization filters.

TypeAPI Key (header: api_key)

Parameters

Path Parameters

petId*

ID of pet to return

Typeinteger

Required

formatint64

Responses

successful operation

Content-Type

JSON

{

"id": 0,

"category": {

"id": 0,

"name": "string",

"sub": {

"prop1": "string"

}

"name": "Guru",

"photoUrls": "string",

"friend": "[Circular Reference]",

"tags": [

{

"id": 0,

"name": "string"

}

"status": "string",

"petType": "string",

"huntingSkill": {

}

GET

/pet/{petId}

Server

Samples

Bruno

get {
  url: //petstore.swagger.io/v2/pet/{petId}
}

headers {
  Content-Type: application/json
}

Bruno

get {
  url: //petstore.swagger.io/v2/pet/{petId}
}

headers {
  Content-Type: application/json
}

cURL

curl -X GET \
'//petstore.swagger.io/v2/pet/{petId}' \
 -H "Content-Type: application/json"

JavaScript

fetch('//petstore.swagger.io/v2/pet/{petId}', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/pet/{petId}';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/pet/{petId}'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

ID: updatePetWithForm

Updates a pet in the store with form data

pet

POST

/pet/{petId}

Server

Authorizations

petstore_auth

Get access to data while protecting your account credentials.
OAuth2 is also a safer and more secure way to give you access.

implicit Flow:

Authorization URL: http://petstore.swagger.io/api/oauth/dialogToken URL:

Scopes:

write:pets: modify pets in your account
read:pets: read your pets

Parameters

Path Parameters

petId*

ID of pet that needs to be updated

Typeinteger

Required

formatint64

Request Body

JSON

{

"name": "string",

"status": "string"

}

Responses

Invalid input

POST

/pet/{petId}

Server

Samples

Bruno

post {
  url: //petstore.swagger.io/v2/pet/{petId}
}

headers {
  Content-Type: application/json
}

Bruno

post {
  url: //petstore.swagger.io/v2/pet/{petId}
}

headers {
  Content-Type: application/json
}

cURL

curl -X POST \
'//petstore.swagger.io/v2/pet/{petId}' \
 -H "Content-Type: application/json"

JavaScript

fetch('//petstore.swagger.io/v2/pet/{petId}', {method:'POST',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/pet/{petId}';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/pet/{petId}'

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())

ID: deletePet

Deletes a pet

pet

DELETE

/pet/{petId}

Server

Authorizations

petstore_auth

Get access to data while protecting your account credentials.
OAuth2 is also a safer and more secure way to give you access.

implicit Flow:

Authorization URL: http://petstore.swagger.io/api/oauth/dialogToken URL:

Scopes:

write:pets: modify pets in your account
read:pets: read your pets

Parameters

Header Parameters

api_key

Typestring

ExampleBearer <TOKEN>

Path Parameters

petId*

Pet id to delete

Typeinteger

Required

formatint64

Responses

Invalid pet value

DELETE

/pet/{petId}

Server

Samples

Bruno

delete {
  url: //petstore.swagger.io/v2/pet/{petId}
}

headers {
  Content-Type: application/json
  api_key: Bearer 
}

Bruno

delete {
  url: //petstore.swagger.io/v2/pet/{petId}
}

headers {
  Content-Type: application/json
  api_key: Bearer 
}

cURL

curl -X DELETE \
'//petstore.swagger.io/v2/pet/{petId}' \
 -H "Content-Type: application/json" \
 -H "api_key: Bearer <TOKEN>"

JavaScript

fetch('//petstore.swagger.io/v2/pet/{petId}', {method:'DELETE',headers:{'Content-Type':'application/json','api_key':'Bearer <TOKEN>'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/pet/{petId}';
$method = 'DELETE';
$headers = [
    'Content-Type' => 'application/json',
    'api_key' => 'Bearer <TOKEN>',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/pet/{petId}'

headers = {
    'Content-Type': 'application/json',
    'api_key': 'Bearer <TOKEN>'
}

response = requests.delete(url, headers=headers)
print(response.json())

ID: uploadFile

uploads an image

pet

POST

/pet/{petId}/uploadImage

Server

Authorizations

petstore_auth

Get access to data while protecting your account credentials.
OAuth2 is also a safer and more secure way to give you access.

implicit Flow:

Authorization URL: http://petstore.swagger.io/api/oauth/dialogToken URL:

Scopes:

write:pets: modify pets in your account
read:pets: read your pets

Parameters

Path Parameters

petId*

ID of pet to update

Typeinteger

Required

formatint64

Request Body

JSON

"string"

Responses

successful operation

Content-Type

application/json

JSON

{

"code": 0,

"type": "string",

"message": "string"

}

POST

/pet/{petId}/uploadImage

Server

Samples

Bruno

post {
  url: //petstore.swagger.io/v2/pet/{petId}/uploadImage
}

headers {
  Content-Type: application/json
}

Bruno

post {
  url: //petstore.swagger.io/v2/pet/{petId}/uploadImage
}

headers {
  Content-Type: application/json
}

cURL

curl -X POST \
'//petstore.swagger.io/v2/pet/{petId}/uploadImage' \
 -H "Content-Type: application/json"

JavaScript

fetch('//petstore.swagger.io/v2/pet/{petId}/uploadImage', {method:'POST',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/pet/{petId}/uploadImage';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/pet/{petId}/uploadImage'

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())

ID: findPetsByStatus

Finds Pets by status

pet

GET

/pet/findByStatus

Server

Multiple status values can be provided with comma separated strings

Authorizations

petstore_auth

Get access to data while protecting your account credentials.
OAuth2 is also a safer and more secure way to give you access.

implicit Flow:

Authorization URL: http://petstore.swagger.io/api/oauth/dialogToken URL:

Scopes:

write:pets: modify pets in your account
read:pets: read your pets

Parameters

Query Parameters

status*

Status values that need to be considered for filter

Typearray

Required

minItems1

maxItems3

Responses

successful operation

Content-Type

JSON

[

{

"id": 0,

"category": {

"id": 0,

"name": "string",

"sub": {

"prop1": "string"

}

"name": "Guru",

"photoUrls": "string",

"friend": "[Circular Reference]",

"tags": [

{

"id": 0,

"name": "string"

}

"status": "string",

"petType": "string",

"huntingSkill": {

}

]

GET

/pet/findByStatus

Server

Samples

Bruno

get {
  url: //petstore.swagger.io/v2/pet/findByStatus
}

headers {
  Content-Type: application/json
}

Bruno

get {
  url: //petstore.swagger.io/v2/pet/findByStatus
}

headers {
  Content-Type: application/json
}

cURL

curl -X GET \
'//petstore.swagger.io/v2/pet/findByStatus' \
 -H "Content-Type: application/json"

JavaScript

fetch('//petstore.swagger.io/v2/pet/findByStatus', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/pet/findByStatus';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/pet/findByStatus'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

Deprecated

ID: findPetsByTags

Finds Pets by tags

pet

GET

/pet/findByTags

Server

Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.

Authorizations

petstore_auth

Get access to data while protecting your account credentials.
OAuth2 is also a safer and more secure way to give you access.

implicit Flow:

Authorization URL: http://petstore.swagger.io/api/oauth/dialogToken URL:

Scopes:

write:pets: modify pets in your account
read:pets: read your pets

Parameters

Query Parameters

tags*

Tags to filter by

Typearray

Required

Responses

successful operation

Content-Type

JSON

[

{

"id": 0,

"category": {

"id": 0,

"name": "string",

"sub": {

"prop1": "string"

}

"name": "Guru",

"photoUrls": "string",

"friend": "[Circular Reference]",

"tags": [

{

"id": 0,

"name": "string"

}

"status": "string",

"petType": "string",

"huntingSkill": {

}

]

GET

/pet/findByTags

Server

Samples

Bruno

get {
  url: //petstore.swagger.io/v2/pet/findByTags
}

headers {
  Content-Type: application/json
}

Bruno

get {
  url: //petstore.swagger.io/v2/pet/findByTags
}

headers {
  Content-Type: application/json
}

cURL

curl -X GET \
'//petstore.swagger.io/v2/pet/findByTags' \
 -H "Content-Type: application/json"

JavaScript

fetch('//petstore.swagger.io/v2/pet/findByTags', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/pet/findByTags';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/pet/findByTags'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

store

Access to Petstore orders

Operations

GET/store/inventory POST/store/order GET/store/order/{orderId}DELETE/store/order/{orderId}POST/store/subscribe

ID: getInventory

Returns pet inventories by status

store

GET

/store/inventory

Server

Returns a map of status codes to quantities

Authorizations

api_key

For this sample, you can use the api key special-key to test the authorization filters.

TypeAPI Key (header: api_key)

Responses

successful operation

Content-Type

application/json

JSON

{

"additionalProperties": 0

}

GET

/store/inventory

Server

Samples

Bruno

get {
  url: //petstore.swagger.io/v2/store/inventory
}

headers {
  Content-Type: application/json
}

Bruno

get {
  url: //petstore.swagger.io/v2/store/inventory
}

headers {
  Content-Type: application/json
}

cURL

curl -X GET \
'//petstore.swagger.io/v2/store/inventory' \
 -H "Content-Type: application/json"

JavaScript

fetch('//petstore.swagger.io/v2/store/inventory', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/store/inventory';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/store/inventory'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

ID: placeOrder

Place an order for a pet

store

POST

/store/order

Server

Request Body

JSON

{

"id": 0,

"petId": 0,

"quantity": 0,

"shipDate": "string",

"status": "string",

"complete": true,

"requestId": "string"

}

Responses

successful operation

Content-Type

JSON

{

"id": 0,

"petId": 0,

"quantity": 0,

"shipDate": "string",

"status": "string",

"complete": true,

"requestId": "string"

}

POST

/store/order

Server

Samples

Bruno

post {
  url: //petstore.swagger.io/v2/store/order
}

headers {
  Content-Type: application/json
}

Bruno

post {
  url: //petstore.swagger.io/v2/store/order
}

headers {
  Content-Type: application/json
}

cURL

curl -X POST \
'//petstore.swagger.io/v2/store/order' \
 -H "Content-Type: application/json"

JavaScript

fetch('//petstore.swagger.io/v2/store/order', {method:'POST',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/store/order';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/store/order'

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())

ID: getOrderById

Find purchase order by ID

store

GET

/store/order/{orderId}

Server

For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions

Parameters

Path Parameters

orderId*

ID of pet that needs to be fetched

Typeinteger

Required

formatint64

minimum1

maximum5

Responses

successful operation

Content-Type

JSON

{

"id": 0,

"petId": 0,

"quantity": 0,

"shipDate": "string",

"status": "string",

"complete": true,

"requestId": "string"

}

GET

/store/order/{orderId}

Server

Samples

Bruno

get {
  url: //petstore.swagger.io/v2/store/order/{orderId}
}

headers {
  Content-Type: application/json
}

Bruno

get {
  url: //petstore.swagger.io/v2/store/order/{orderId}
}

headers {
  Content-Type: application/json
}

cURL

curl -X GET \
'//petstore.swagger.io/v2/store/order/{orderId}' \
 -H "Content-Type: application/json"

JavaScript

fetch('//petstore.swagger.io/v2/store/order/{orderId}', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/store/order/{orderId}';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/store/order/{orderId}'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

ID: deleteOrder

Delete purchase order by ID

store

DELETE

/store/order/{orderId}

Server

For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors

Parameters

Path Parameters

orderId*

ID of the order that needs to be deleted

Typestring

Required

minimum1

Responses

Invalid ID supplied

DELETE

/store/order/{orderId}

Server

Samples

Bruno

delete {
  url: //petstore.swagger.io/v2/store/order/{orderId}
}

headers {
  Content-Type: application/json
}

Bruno

delete {
  url: //petstore.swagger.io/v2/store/order/{orderId}
}

headers {
  Content-Type: application/json
}

cURL

curl -X DELETE \
'//petstore.swagger.io/v2/store/order/{orderId}' \
 -H "Content-Type: application/json"

JavaScript

fetch('//petstore.swagger.io/v2/store/order/{orderId}', {method:'DELETE',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/store/order/{orderId}';
$method = 'DELETE';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/store/order/{orderId}'

headers = {
    'Content-Type': 'application/json'
}

response = requests.delete(url, headers=headers)
print(response.json())

ID: post-store-subscribe

store

POST

/store/subscribe

Server

Add subscription for a store events

JSON

{

"callbackUrl": "https://myserver.com/send/callback/here",

"eventName": "string"

}

Successful operation

Content-Type

application/json

JSON

[

]

POST

/store/subscribe

Server

Bruno

post {
  url: //petstore.swagger.io/v2/store/subscribe
}

headers {
  Content-Type: application/json
}

Bruno

post {
  url: //petstore.swagger.io/v2/store/subscribe
}

headers {
  Content-Type: application/json
}

cURL

curl -X POST \
'//petstore.swagger.io/v2/store/subscribe' \
 -H "Content-Type: application/json"

JavaScript

fetch('//petstore.swagger.io/v2/store/subscribe', {method:'POST',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/store/subscribe';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/store/subscribe'

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())

user

Operations about user

Operations

POST/user GET/user/{username}PUT/user/{username}DELETE/user/{username}POST/user/createWithArray POST/user/createWithList GET/user/login GET/user/logout

ID: createUser

Create user

user

POST

/user

Server

This can only be done by the logged in user.

Request Body

JSON

{

"id": 0,

"pet": {

"id": 0,

"category": {

"id": 0,

"name": "string",

"sub": {

"prop1": "string"

}

"name": "Guru",

"photoUrls": "string",

"friend": "[Circular Reference]",

"tags": [

{

"id": 0,

"name": "string"

}

"status": "string",

"petType": "string",

"huntingSkill": {

}

"username": "John78",

"firstName": "John",

"lastName": "Smith",

"email": "john.smith@example.com",

"password": "drowssaP123",

"phone": "+1-202-555-0192",

"userStatus": 0,

"image": "string",

"addresses": [

"string"

]

}

Responses

successful operation

POST

/user

Server

Samples

Bruno

post {
  url: //petstore.swagger.io/v2/user
}

headers {
  Content-Type: application/json
}

Bruno

post {
  url: //petstore.swagger.io/v2/user
}

headers {
  Content-Type: application/json
}

cURL

curl -X POST \
'//petstore.swagger.io/v2/user' \
 -H "Content-Type: application/json"

JavaScript

fetch('//petstore.swagger.io/v2/user', {method:'POST',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/user';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/user'

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())

ID: getUserByName

Get user by user name

user

GET

/user/{username}

Server

Parameters

Path Parameters

username*

The name that needs to be fetched. Use user1 for testing.

Typestring

Required

Responses

successful operation

Content-Type

JSON

{

"id": 0,

"pet": {

"id": 0,

"category": {

"id": 0,

"name": "string",

"sub": {

"prop1": "string"

}

"name": "Guru",

"photoUrls": "string",

"friend": "[Circular Reference]",

"tags": [

{

"id": 0,

"name": "string"

}

"status": "string",

"petType": "string",

"huntingSkill": {

}

"username": "John78",

"firstName": "John",

"lastName": "Smith",

"email": "john.smith@example.com",

"password": "drowssaP123",

"phone": "+1-202-555-0192",

"userStatus": 0,

"image": "string",

"addresses": [

"string"

]

}

GET

/user/{username}

Server

Samples

Bruno

get {
  url: //petstore.swagger.io/v2/user/{username}
}

headers {
  Content-Type: application/json
}

Bruno

get {
  url: //petstore.swagger.io/v2/user/{username}
}

headers {
  Content-Type: application/json
}

cURL

curl -X GET \
'//petstore.swagger.io/v2/user/{username}' \
 -H "Content-Type: application/json"

JavaScript

fetch('//petstore.swagger.io/v2/user/{username}', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/user/{username}';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/user/{username}'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

ID: updateUser

Updated user

user

PUT

/user/{username}

Server

This can only be done by the logged in user.

Parameters

Path Parameters

username*

name that need to be updated

Typestring

Required

Request Body

JSON

{

"id": 0,

"pet": {

"id": 0,

"category": {

"id": 0,

"name": "string",

"sub": {

"prop1": "string"

}

"name": "Guru",

"photoUrls": "string",

"friend": "[Circular Reference]",

"tags": [

{

"id": 0,

"name": "string"

}

"status": "string",

"petType": "string",

"huntingSkill": {

}

"username": "John78",

"firstName": "John",

"lastName": "Smith",

"email": "john.smith@example.com",

"password": "drowssaP123",

"phone": "+1-202-555-0192",

"userStatus": 0,

"image": "string",

"addresses": [

"string"

]

}

Responses

User is updated successfully

Content-Type

application/json

JSON

{

"id": 0,

"pet": {

"id": 0,

"category": {

"id": 0,

"name": "string",

"sub": {

"prop1": "string"

}

"name": "Guru",

"photoUrls": "string",

"friend": "[Circular Reference]",

"tags": [

{

"id": 0,

"name": "string"

}

"status": "string",

"petType": "string",

"huntingSkill": {

}

"username": "John78",

"firstName": "John",

"lastName": "Smith",

"email": "john.smith@example.com",

"password": "drowssaP123",

"phone": "+1-202-555-0192",

"userStatus": 0,

"image": "string",

"addresses": [

"string"

]

}

PUT

/user/{username}

Server

Samples

Bruno

put {
  url: //petstore.swagger.io/v2/user/{username}
}

headers {
  Content-Type: application/json
}

Bruno

put {
  url: //petstore.swagger.io/v2/user/{username}
}

headers {
  Content-Type: application/json
}

cURL

curl -X PUT \
'//petstore.swagger.io/v2/user/{username}' \
 -H "Content-Type: application/json"

JavaScript

fetch('//petstore.swagger.io/v2/user/{username}', {method:'PUT',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/user/{username}';
$method = 'PUT';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/user/{username}'

headers = {
    'Content-Type': 'application/json'
}

response = requests.put(url, headers=headers)
print(response.json())

ID: deleteUser

Delete user

user

DELETE

/user/{username}

Server

This can only be done by the logged in user.

Parameters

Path Parameters

username*

The name that needs to be deleted

Typestring

Required

Responses

User is deleted

DELETE

/user/{username}

Server

Samples

Bruno

delete {
  url: //petstore.swagger.io/v2/user/{username}
}

headers {
  Content-Type: application/json
}

Bruno

delete {
  url: //petstore.swagger.io/v2/user/{username}
}

headers {
  Content-Type: application/json
}

cURL

curl -X DELETE \
'//petstore.swagger.io/v2/user/{username}' \
 -H "Content-Type: application/json"

JavaScript

fetch('//petstore.swagger.io/v2/user/{username}', {method:'DELETE',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/user/{username}';
$method = 'DELETE';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/user/{username}'

headers = {
    'Content-Type': 'application/json'
}

response = requests.delete(url, headers=headers)
print(response.json())

ID: createUsersWithArrayInput

Creates list of users with given input array

user

POST

/user/createWithArray

Server

Request Body

JSON

[

{

"id": 0,

"pet": {

"id": 0,

"category": {

"id": 0,

"name": "string",

"sub": {

"prop1": "string"

}

"name": "Guru",

"photoUrls": "string",

"friend": "[Circular Reference]",

"tags": [

{

"id": 0,

"name": "string"

}

"status": "string",

"petType": "string",

"huntingSkill": {

}

"username": "John78",

"firstName": "John",

"lastName": "Smith",

"email": "john.smith@example.com",

"password": "drowssaP123",

"phone": "+1-202-555-0192",

"userStatus": 0,

"image": "string",

"addresses": [

"string"

]

}

]

Responses

successful operation

POST

/user/createWithArray

Server

Samples

Bruno

post {
  url: //petstore.swagger.io/v2/user/createWithArray
}

headers {
  Content-Type: application/json
}

Bruno

post {
  url: //petstore.swagger.io/v2/user/createWithArray
}

headers {
  Content-Type: application/json
}

cURL

curl -X POST \
'//petstore.swagger.io/v2/user/createWithArray' \
 -H "Content-Type: application/json"

JavaScript

fetch('//petstore.swagger.io/v2/user/createWithArray', {method:'POST',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/user/createWithArray';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/user/createWithArray'

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())

ID: createUsersWithListInput

Creates list of users with given input array

user

POST

/user/createWithList

Server

Request Body

JSON

[

{

"id": 0,

"pet": {

"id": 0,

"category": {

"id": 0,

"name": "string",

"sub": {

"prop1": "string"

}

"name": "Guru",

"photoUrls": "string",

"friend": "[Circular Reference]",

"tags": [

{

"id": 0,

"name": "string"

}

"status": "string",

"petType": "string",

"huntingSkill": {

}

"username": "John78",

"firstName": "John",

"lastName": "Smith",

"email": "john.smith@example.com",

"password": "drowssaP123",

"phone": "+1-202-555-0192",

"userStatus": 0,

"image": "string",

"addresses": [

"string"

]

}

]

Responses

successful operation

POST

/user/createWithList

Server

Samples

Bruno

post {
  url: //petstore.swagger.io/v2/user/createWithList
}

headers {
  Content-Type: application/json
}

Bruno

post {
  url: //petstore.swagger.io/v2/user/createWithList
}

headers {
  Content-Type: application/json
}

cURL

curl -X POST \
'//petstore.swagger.io/v2/user/createWithList' \
 -H "Content-Type: application/json"

JavaScript

fetch('//petstore.swagger.io/v2/user/createWithList', {method:'POST',headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/user/createWithList';
$method = 'POST';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/user/createWithList'

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, headers=headers)
print(response.json())

ID: loginUser

Logs user into the system

user

GET

/user/login

Server

Parameters

Query Parameters

username*

The user name for login

Typestring

Required

password*

The password for login in clear text

Typestring

Required

Responses

successful operation

Content-Type

JSON

"OK"

GET

/user/login

Server

Samples

Bruno

get {
  url: //petstore.swagger.io/v2/user/login
}

headers {
  Content-Type: application/json
}

Bruno

get {
  url: //petstore.swagger.io/v2/user/login
}

headers {
  Content-Type: application/json
}

cURL

curl -X GET \
'//petstore.swagger.io/v2/user/login' \
 -H "Content-Type: application/json"

JavaScript

fetch('//petstore.swagger.io/v2/user/login', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/user/login';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/user/login'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

ID: logoutUser

Logs out current logged in user session

user

GET

/user/logout

Server

Responses

successful operation

GET

/user/logout

Server

Samples

Bruno

get {
  url: //petstore.swagger.io/v2/user/logout
}

headers {
  Content-Type: application/json
}

Bruno

get {
  url: //petstore.swagger.io/v2/user/logout
}

headers {
  Content-Type: application/json
}

cURL

curl -X GET \
'//petstore.swagger.io/v2/user/logout' \
 -H "Content-Type: application/json"

JavaScript

fetch('//petstore.swagger.io/v2/user/logout', {headers:{'Content-Type':'application/json'}})
  .then(response => response.json())
  .then(data => console.log(data));

PHP

<?php
$url = '//petstore.swagger.io/v2/user/logout';
$method = 'GET';
$headers = [
    'Content-Type' => 'application/json',
];

$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, $method);
curl_setopt($ch, CURLOPT_HTTPHEADER, $headers);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
?>

Python

import requests

url = '//petstore.swagger.io/v2/user/logout'

headers = {
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
print(response.json())

Swagger Petstore​

Introduction

OpenAPI Specification

Cross-Origin Resource Sharing

Authentication

Contact​

Terms of Service​

License​

External Documentation​

Servers​

pet​

Operations​

OperationId with backslash​

Samples​

Add a new pet to the store​

Authorizations​

Request Body​

Responses​

Samples​

Update an existing pet​

Authorizations​

Request Body​

Responses​

Samples​

OperationId with quotes​

Samples​

Find pet by ID​

Authorizations​

Parameters​

Path Parameters

Responses​

Samples​

Updates a pet in the store with form data​

Authorizations​

Parameters​

Path Parameters

Request Body​

Responses​

Samples​

Deletes a pet​

Authorizations​

Parameters​

Header Parameters

Path Parameters

Responses​

Samples​

uploads an image​

Authorizations​

Parameters​

Path Parameters

Request Body​

Responses​

Samples​

Finds Pets by status​

Authorizations​

Parameters​

Query Parameters

Responses​

Samples​

Finds Pets by tags​

Authorizations​

Parameters​

Query Parameters

Responses​

Samples​

store​

Operations​

Returns pet inventories by status​

Authorizations​

Responses​

Samples​

Place an order for a pet​

Request Body​

Responses​

Samples​

Find purchase order by ID​

Parameters​

Path Parameters

Responses​

Samples​

Swagger Petstore

Contact

Terms of Service

License

External Documentation

Servers

pet

Operations

OperationId with backslash

Samples

Add a new pet to the store

Authorizations

Request Body

Responses

Samples

Update an existing pet

Authorizations

Request Body

Responses

Samples

OperationId with quotes

Samples

Find pet by ID

Authorizations

Parameters

Responses

Samples

Updates a pet in the store with form data

Authorizations

Parameters

Request Body

Responses

Samples

Deletes a pet

Authorizations

Parameters

Responses

Samples

uploads an image

Authorizations

Parameters

Request Body

Responses

Samples

Finds Pets by status

Authorizations

Parameters

Responses

Samples

Finds Pets by tags

Authorizations

Parameters

Responses

Samples

store

Operations

Returns pet inventories by status

Authorizations

Responses

Samples

Place an order for a pet

Request Body

Responses

Samples

Find purchase order by ID

Parameters

Responses

Samples

Delete purchase order by ID

Parameters

Responses

Samples

Subscribe to the Store events

Request Body

Responses

Samples

user

Operations

Create user

Request Body