Swagger Petstore
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
Version: 1.0.0
Apache 2.0
http://www.apache.org/licenses/LICENSE-2.0.html
Access
[ Jump to Models ]
Table of Contents
post /petpost /pet?testing_byte_array=truedelete /pet/{petId}get /pet/findByStatusget /pet/findByTagsget /pet/{petId}get /pet/{petId}?response=inline_arbitrary_objectget /pet/{petId}?testing_byte_array=trueput /petpost /pet/{petId}post /pet/{petId}/uploadImagedelete /store/order/{orderId}get /store/findByStatusget /store/inventoryget /store/inventory?response=arbitrary_objectget /store/order/{orderId}post /store/orderpost /userpost /user/createWithArraypost /user/createWithListdelete /user/{username}get /user/{username}get /user/loginget /user/logoutput /user/{username}
Add a new pet to the store (addPet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
application/jsonapplication/xml
Request body
body (optional)
Body Parameter — Pet object that needs to be added to the store
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
405
Invalid input
Up
post /pet?testing_byte_array=true
Fake endpoint to test byte array in body parameter for adding a new pet to the store (addPetUsingByteArray)
Consumes
This API call consumes the following media types via the
Content-Type request header:
application/jsonapplication/xml
Request body
body (optional)
Body Parameter — Pet object in the form of byte array
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
405
Invalid input
Deletes a pet (deletePet)
Path parameters
petId (required)
Path Parameter — Pet id to delete
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
400
Invalid pet value
Finds Pets by status (findPetsByStatus)
Multiple status values can be provided with comma separated strings
Query parameters
status (optional)
Query Parameter — Status values that need to be considered for query default: available
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
200
successful operation
400
Invalid status value
Finds Pets by tags (findPetsByTags)
Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
Query parameters
tags (optional)
Query Parameter — Tags to filter by
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
200
successful operation
400
Invalid tag value
Find pet by ID (getPetById)
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
Path parameters
petId (required)
Path Parameter — ID of pet that needs to be fetched
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
200
successful operation
400
Invalid ID supplied
404
Pet not found
Up
get /pet/{petId}?response=inline_arbitrary_object
Fake endpoint to test inline arbitrary object return by 'Find pet by ID' (getPetByIdInObject)
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
Path parameters
petId (required)
Path Parameter — ID of pet that needs to be fetched
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
200
successful operation
400
Invalid ID supplied
404
Pet not found
Up
get /pet/{petId}?testing_byte_array=true
Fake endpoint to test byte array return by 'Find pet by ID' (petPetIdtestingByteArraytrueGet)
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
Path parameters
petId (required)
Path Parameter — ID of pet that needs to be fetched
Return type
byte[]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
200
successful operation
400
Invalid ID supplied
404
Pet not found
Update an existing pet (updatePet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
application/jsonapplication/xml
Request body
body (optional)
Body Parameter — Pet object that needs to be added to the store
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
400
Invalid ID supplied
404
Pet not found
405
Validation exception
Updates a pet in the store with form data (updatePetWithForm)
Path parameters
petId (required)
Path Parameter — ID of pet that needs to be updated
Consumes
This API call consumes the following media types via the
Content-Type request header:
application/x-www-form-urlencoded
Form parameters
name (optional)
Form Parameter — Updated name of the pet
status (optional)
Form Parameter — Updated status of the pet
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
405
Invalid input
Up
post /pet/{petId}/uploadImage
uploads an image (uploadFile)
Path parameters
petId (required)
Path Parameter — ID of pet to update
Consumes
This API call consumes the following media types via the
Content-Type request header:
Form parameters
additionalMetadata (optional)
Form Parameter — Additional data to pass to server
file (optional)
Form Parameter — file to upload
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
0
successful operation
Up
delete /store/order/{orderId}
Delete purchase order by ID (deleteOrder)
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
Path parameters
orderId (required)
Path Parameter — ID of the order that needs to be deleted
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
400
Invalid ID supplied
404
Order not found
Up
get /store/findByStatus
Finds orders by status (findOrdersByStatus)
A single status value can be provided as a string
Query parameters
status (optional)
Query Parameter — Status value that needs to be considered for query default: placed
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
200
successful operation
400
Invalid status value
Returns pet inventories by status (getInventory)
Returns a map of status codes to quantities
Return type
map[String, Integer]
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
200
successful operation
Up
get /store/inventory?response=arbitrary_object
Fake endpoint to test arbitrary object return by 'Get inventory' (getInventoryInObject)
Returns an arbitrary object which is actually a map of status codes to quantities
Return type
Object
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
200
successful operation
Up
get /store/order/{orderId}
Find purchase order by ID (getOrderById)
For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
Path parameters
orderId (required)
Path Parameter — ID of pet that needs to be fetched
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
200
successful operation
400
Invalid ID supplied
404
Order not found
Place an order for a pet (placeOrder)
Request body
body (optional)
Body Parameter — order placed for purchasing the pet
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
200
successful operation
400
Invalid Order
Create user (createUser)
This can only be done by the logged in user.
Request body
body (optional)
Body Parameter — Created user object
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
0
successful operation
Up
post /user/createWithArray
Creates list of users with given input array (createUsersWithArrayInput)
Request body
body (optional)
Body Parameter — List of user object
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
0
successful operation
Up
post /user/createWithList
Creates list of users with given input array (createUsersWithListInput)
Request body
body (optional)
Body Parameter — List of user object
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
0
successful operation
Up
delete /user/{username}
Delete user (deleteUser)
This can only be done by the logged in user.
Path parameters
username (required)
Path Parameter — The name that needs to be deleted
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
400
Invalid username supplied
404
User not found
Get user by user name (getUserByName)
Path parameters
username (required)
Path Parameter — The name that needs to be fetched. Use user1 for testing.
Return type
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
200
successful operation
Example data
Content-Type: application/json
{id=1, username=johnp, firstName=John, lastName=Public, email=johnp@swagger.io, password=-secret-, phone=0123456789, userStatus=0}
400
Invalid username supplied
404
User not found
Logs user into the system (loginUser)
Query parameters
username (optional)
Query Parameter — The user name for login
password (optional)
Query Parameter — The password for login in clear text
Return type
String
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
200
successful operation
400
Invalid username/password supplied
Logs out current logged in user session (logoutUser)
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
0
successful operation
Updated user (updateUser)
This can only be done by the logged in user.
Path parameters
username (required)
Path Parameter — name that need to be deleted
Request body
body (optional)
Body Parameter — Updated user object
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
application/jsonapplication/xml
Responses
400
Invalid user supplied
404
User not found
[ Jump to Methods ]
Table of Contents
$special[model.name]200_responseAnimalCatCategoryDogFormat_testInline_response_200NameOrderPetReturnTagUser
$special[property.name]
Long
className
String
declawed
Boolean
className
String
breed
String
integer
Integer
int32
Integer
int64
Long
number
BigDecimal
float
Float
double
Double
string
String
byte
byte[]
binary
byte[]
date
date
dateTime
String
tags
array[Tag]
id
Long
category
Object
status
String pet status in the store
available
pending
sold
name
String
photoUrls
array[String]
name
Integer
snake_case
Integer
id
Long
petId
Long
quantity
Integer
shipDate
Date
status
String Order Status
placed
approved
delivered
complete
Boolean
id
Long
category
Category
name
String
photoUrls
array[String]
tags
array[Tag]
status
String pet status in the store
available
pending
sold
id
Long
username
String
firstName
String
lastName
String
email
String
password
String
phone
String
userStatus
Integer User Status