Skip to content
/
Logs out current logged i...

Swagger Petstore - OpenAPI 3.0 (1.0.20-SNAPSHOT)

Find out more about Swagger

This is a sample Pet Store Server based on the OpenAPI 3.0 specification.

You can find out more about

Swagger at http://swagger.io. In the third iteration of the pet store, we've switched to the design first approach!

You can now help us improve the API whether it's by making changes to the definition itself or to the code.

That way, with time, we can improve the API in general, and expose some of the new features in OAS3.

Some useful links:

Download OpenAPI description
petstore.json
petstore.yaml
Overview
E-mail
apiteam@swagger.io
License
Apache 2.0
Terms of Service
Languages
Servers
Mock server
https://phronesis-creativara.redocly.app/_mock/products/api-hub/petstore
https://phronesis-creativara.redocly.app/v3

pet

Everything about your Pets

Operations

store

Access to Petstore orders

Operations

user

Operations about user

Operations

Create user

Request

This can only be done by the logged in user.

Body

Created user object

idinteger(int64)
Example: 10
usernamestring
Example: "theUser"
firstNamestring
Example: "John"
lastNamestring
Example: "James"
emailstring
Example: "john@email.com"
passwordstring
Example: 12345
phonestring
Example: 12345
userStatusinteger(int32)

User Status

Example: 1
curl -i -X POST \
  https://phronesis-creativara.redocly.app/_mock/products/api-hub/petstore/user \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 10,
    "username": "theUser",
    "firstName": "John",
    "lastName": "James",
    "email": "john@email.com",
    "password": 12345,
    "phone": 12345,
    "userStatus": 1
  }'

Responses

successful operation

Body
idinteger(int64)
Example: 10
usernamestring
Example: "theUser"
firstNamestring
Example: "John"
lastNamestring
Example: "James"
emailstring
Example: "john@email.com"
passwordstring
Example: 12345
phonestring
Example: 12345
userStatusinteger(int32)

User Status

Example: 1
Response
{
  "id": 10,
  "username": "theUser",
  "firstName": "John",
  "lastName": "James",
  "email": "john@email.com",
  "password": 12345,
  "phone": 12345,
  "userStatus": 1
}

Creates list of users with given input array

Request

Creates list of users with given input array

Bodyapplication/jsonArray [
idinteger(int64)
Example: 10
usernamestring
Example: "theUser"
firstNamestring
Example: "John"
lastNamestring
Example: "James"
emailstring
Example: "john@email.com"
passwordstring
Example: 12345
phonestring
Example: 12345
userStatusinteger(int32)

User Status

Example: 1
]
curl -i -X POST \
  https://phronesis-creativara.redocly.app/_mock/products/api-hub/petstore/user/createWithList \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "id": 10,
      "username": "theUser",
      "firstName": "John",
      "lastName": "James",
      "email": "john@email.com",
      "password": 12345,
      "phone": 12345,
      "userStatus": 1
    }
  ]'

Responses

Successful operation

Body
idinteger(int64)
Example: 10
usernamestring
Example: "theUser"
firstNamestring
Example: "John"
lastNamestring
Example: "James"
emailstring
Example: "john@email.com"
passwordstring
Example: 12345
phonestring
Example: 12345
userStatusinteger(int32)

User Status

Example: 1
Response
<user>
  <id>10</id>
  <username>theUser</username>
  <firstName>John</firstName>
  <lastName>James</lastName>
  <email>john@email.com</email>
  <password>12345</password>
  <phone>12345</phone>
  <userStatus>1</userStatus>
</user>

Logs user into the system

Request

Query
usernamestring

The user name for login

passwordstring

The password for login in clear text

curl -i -X GET \
  'https://phronesis-creativara.redocly.app/_mock/products/api-hub/petstore/user/login?username=string&password=string'

Responses

successful operation

Headers
X-Rate-Limitinteger(int32)

calls per hour allowed by the user

X-Expires-Afterstring(date-time)

date in UTC when token expires

Body
string
Response
<root>string</root>

Logs out current logged in user session

Request

curl -i -X GET \
  https://phronesis-creativara.redocly.app/_mock/products/api-hub/petstore/user/logout

Responses

successful operation

Get user by user name

Request

Path
usernamestringrequired

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

curl -i -X GET \
  'https://phronesis-creativara.redocly.app/_mock/products/api-hub/petstore/user/{username}'

Responses

successful operation

Body
idinteger(int64)
Example: 10
usernamestring
Example: "theUser"
firstNamestring
Example: "John"
lastNamestring
Example: "James"
emailstring
Example: "john@email.com"
passwordstring
Example: 12345
phonestring
Example: 12345
userStatusinteger(int32)

User Status

Example: 1
Response
<user>
  <id>10</id>
  <username>theUser</username>
  <firstName>John</firstName>
  <lastName>James</lastName>
  <email>john@email.com</email>
  <password>12345</password>
  <phone>12345</phone>
  <userStatus>1</userStatus>
</user>

Update user

Request

This can only be done by the logged in user.

Path
usernamestringrequired

name that needs to be updated

Body

Update an existent user in the store

idinteger(int64)
Example: 10
usernamestring
Example: "theUser"
firstNamestring
Example: "John"
lastNamestring
Example: "James"
emailstring
Example: "john@email.com"
passwordstring
Example: 12345
phonestring
Example: 12345
userStatusinteger(int32)

User Status

Example: 1
curl -i -X PUT \
  'https://phronesis-creativara.redocly.app/_mock/products/api-hub/petstore/user/{username}' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": 10,
    "username": "theUser",
    "firstName": "John",
    "lastName": "James",
    "email": "john@email.com",
    "password": 12345,
    "phone": 12345,
    "userStatus": 1
  }'

Responses

successful operation

Delete user

Request

This can only be done by the logged in user.

Path
usernamestringrequired

The name that needs to be deleted

curl -i -X DELETE \
  'https://phronesis-creativara.redocly.app/_mock/products/api-hub/petstore/user/{username}'

Responses

Invalid username supplied