Reference
1.0.11
OAS 3.0.2

Swagger Petstore - OpenAPI 3.0

Download OpenAPI Spec
Base URL
https://petstore3.swagger.io/api/v3
Client Libraries
Shell
Ruby
Node.js
PHP
Python
C
More
Shell cURL
Authentication

pet​

Endpoints
PUT/petPOST/petGET/pet/findByStatusGET/pet/findByTagsGET/pet/{petId}POST/pet/{petId}DELETE/pet/{petId}POST/pet/{petId}/uploadImagePOST/pet/{petId}/uploadImageForm

Update an existing pet​

Body
application/json
id
integer · int64
example: 10
name
required
string
example: doggie
category
object
photoUrls
required
array string[]
tags
array
status
string · enum
  • available
  • pending
  • sold
Responses
  • 200
  • 400
  • 404
  • 405
PUT/pet
Shell cURL

Add a new pet to the store​

Body
application/json
id
integer · int64
example: 10
name
required
string
example: doggie
category
object
photoUrls
required
array string[]
tags
array
status
string · enum
  • available
  • pending
  • sold
Responses
  • 200
  • 405
POST/pet
Shell cURL

Finds Pets by status​

Query Parameters
  • status
    string · enum
    • available
    • pending
    • sold
Responses
  • 200
  • 400
GET/pet/findByStatus
Shell cURL

Finds Pets by tags​

Query Parameters
  • tags
    array string[]
Responses
  • 200
  • 400
GET/pet/findByTags
Shell cURL

Find pet by ID​

Path Parameters
  • petId
    required
    integer · int64
Responses
  • 200
  • 400
  • 404
GET/pet/{petId}
Shell cURL

Updates a pet in the store with form data​

Path Parameters
  • petId
    required
    integer · int64
Query Parameters
  • name
    string
  • status
    string
Responses
  • 405
POST/pet/{petId}
Shell cURL
No Body

Deletes a pet​

Path Parameters
  • petId
    required
    integer · int64
Headers
  • api_key
    string
Responses
  • 400
DELETE/pet/{petId}
Shell cURL
No Body

uploads an image​

Path Parameters
  • petId
    required
    integer · int64
Query Parameters
  • additionalMetadata
    string
Body
application/octet-stream
string · binary
Responses
  • 200
POST/pet/{petId}/uploadImage
Shell cURL

uploads an image using form data​

Body
multipart/form-data
petId
required
string
example: 1
additionalMetadata
string
file
string · binary
Responses
  • 200
POST/pet/{petId}/uploadImageForm
Shell cURL

store​

Endpoints
GET/store/inventoryPOST/store/orderGET/store/order/{orderId}DELETE/store/order/{orderId}

user​

Endpoints
POST/userPOST/user/createWithListGET/user/loginGET/user/logoutGET/user/{username}PUT/user/{username}DELETE/user/{username}

Order​

{} <order />
id
integer · int64
example: 10
petId
integer · int64
example: 198772
quantity
integer · int32
example: 7
shipDate
string · date-time
status
string · enum
example: approved
  • placed
  • approved
  • delivered
complete
boolean

Customer​

{} <customer />
id
integer · int64
example: 100000
username
string
example: fehguy
address
array

Address​

{} <address />
street
string
example: 437 Lytton
city
string
example: Palo Alto
state
string
example: CA
zip
string
example: 94301