VitePress OpenAPI

Appearance

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

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.

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

External Documentation​

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

Servers​

//petstore.swagger.io/v2Default server
//petstore.swagger.io/sandboxSandbox server

OperationId with backslash​

GET
/pet

Playground​

Samples​

cURL
JavaScript
PHP
Python

Add a new pet to the store​

POST
/pet

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 URLhttp://petstore.swagger.io/api/oauth/dialog
Scopes:
  • write:petsmodify pets in your account
  • read:petsread your pets

Request Body​

JSON
{
"id": 0,
"category": {
"id": 0,
"name": "string",
"sub": {
"prop1": "string"
}
},
"name": "Guru",
"photoUrls": [
],
"friend": "[Circular Reference]",
"tags": [
{
"id": 0,
"name": "string"
}
],
"status": "string",
"petType": "string",
"huntingSkill": {
}
}

Responses​

Invalid input

Playground​

Server
Authorization
Body
JSON

Samples​

cURL
JavaScript
PHP
Python

Update an existing pet​

PUT
/pet

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 URLhttp://petstore.swagger.io/api/oauth/dialog
Scopes:
  • write:petsmodify pets in your account
  • read:petsread your pets

Request Body​

JSON
{
"id": 0,
"category": {
"id": 0,
"name": "string",
"sub": {
"prop1": "string"
}
},
"name": "Guru",
"photoUrls": [
],
"friend": "[Circular Reference]",
"tags": [
{
"id": 0,
"name": "string"
}
],
"status": "string",
"petType": "string",
"huntingSkill": {
}
}

Responses​

Invalid ID supplied

Playground​

Server
Authorization
Body
JSON

Samples​

cURL
JavaScript
PHP
Python

OperationId with quotes​

DELETE
/pet

Playground​

Samples​

cURL
JavaScript
PHP
Python

Find pet by ID​

GET
/pet/{petId}

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
JSON
{
"id": 0,
"category": {
"id": 0,
"name": "string",
"sub": {
"prop1": "string"
}
},
"name": "Guru",
"photoUrls": [
],
"friend": "[Circular Reference]",
"tags": [
{
"id": 0,
"name": "string"
}
],
"status": "string",
"petType": "string",
"huntingSkill": {
}
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

Updates a pet in the store with form data​

POST
/pet/{petId}

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 URLhttp://petstore.swagger.io/api/oauth/dialog
Scopes:
  • write:petsmodify pets in your account
  • read:petsread 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

Playground​

Server
Authorization
Variables
Key
Value
Body
JSON

Samples​

cURL
JavaScript
PHP
Python

Deletes a pet​

DELETE
/pet/{petId}

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 URLhttp://petstore.swagger.io/api/oauth/dialog
Scopes:
  • write:petsmodify pets in your account
  • read:petsread your pets

Parameters​

Header Parameters

api_key
Typestring
ExampleBearer <TOKEN>

Path Parameters

petId*

Pet id to delete

Typeinteger
Required
formatint64

Responses​

Invalid pet value

Playground​

Server
Authorization
Headers
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

uploads an image​

POST
/pet/{petId}/uploadImage

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 URLhttp://petstore.swagger.io/api/oauth/dialog
Scopes:
  • write:petsmodify pets in your account
  • read:petsread your pets

Parameters​

Path Parameters

petId*

ID of pet to update

Typeinteger
Required
formatint64

Request Body​

JSON
"string"

Responses​

successful operation
application/json
JSON
{
"code": 0,
"type": "string",
"message": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

cURL
JavaScript
PHP
Python

Finds Pets by status​

GET
/pet/findByStatus

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 URLhttp://petstore.swagger.io/api/oauth/dialog
Scopes:
  • write:petsmodify pets in your account
  • read:petsread your pets

Parameters​

Query Parameters

status*

Status values that need to be considered for filter

Typearray
Required
minItems1
maxItems3

Responses​

successful operation
JSON
[
{
"id": 0,
"category": {
"id": 0,
"name": "string",
"sub": {
"prop1": "string"
}
},
"name": "Guru",
"photoUrls": [
],
"friend": "[Circular Reference]",
"tags": [
{
"id": 0,
"name": "string"
}
],
"status": "string",
"petType": "string",
"huntingSkill": {
}
}
]

Playground​

Server
Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python
Deprecated

Finds Pets by tags​

GET
/pet/findByTags

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 URLhttp://petstore.swagger.io/api/oauth/dialog
Scopes:
  • write:petsmodify pets in your account
  • read:petsread your pets

Parameters​

Query Parameters

tags*

Tags to filter by

Typearray
Required

Responses​

successful operation
JSON
[
{
"id": 0,
"category": {
"id": 0,
"name": "string",
"sub": {
"prop1": "string"
}
},
"name": "Guru",
"photoUrls": [
],
"friend": "[Circular Reference]",
"tags": [
{
"id": 0,
"name": "string"
}
],
"status": "string",
"petType": "string",
"huntingSkill": {
}
}
]

Playground​

Server
Authorization
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

Returns pet inventories by status​

GET
/store/inventory

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
application/json
JSON
{
"additionalProperties": 0
}

Playground​

Server
Authorization

Samples​

cURL
JavaScript
PHP
Python

Place an order for a pet​

POST
/store/order

Request Body​

JSON
{
"id": 0,
"petId": 0,
"quantity": 1,
"shipDate": "string",
"status": "string",
"complete": false,
"requestId": "string"
}

Responses​

successful operation
JSON
{
"id": 0,
"petId": 0,
"quantity": 1,
"shipDate": "string",
"status": "string",
"complete": false,
"requestId": "string"
}

Playground​

Server
Body
JSON

Samples​

cURL
JavaScript
PHP
Python

Find purchase order by ID​

GET
/store/order/{orderId}

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
JSON
{
"id": 0,
"petId": 0,
"quantity": 1,
"shipDate": "string",
"status": "string",
"complete": false,
"requestId": "string"
}

Playground​

Server
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

Delete purchase order by ID​

DELETE
/store/order/{orderId}

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

Playground​

Server
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

Subscribe to the Store events​

POST
/store/subscribe

Add subscription for a store events

Request Body​

JSON
{
"callbackUrl": "https://myserver.com/send/callback/here",
"eventName": "string"
}

Responses​

Successful operation
application/json
JSON
[
[
]
]

Playground​

Server
Body
JSON

Samples​

cURL
JavaScript
PHP
Python

Create user​

POST
/user

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": [
],
"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

Playground​

Server
Body
JSON

Samples​

cURL
JavaScript
PHP
Python

Get user by user name​

GET
/user/{username}

Parameters​

Path Parameters

username*

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

Typestring
Required

Responses​

successful operation
JSON
{
"id": 0,
"pet": {
"id": 0,
"category": {
"id": 0,
"name": "string",
"sub": {
"prop1": "string"
}
},
"name": "Guru",
"photoUrls": [
],
"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"
]
}

Playground​

Server
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

Updated user​

PUT
/user/{username}

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": [
],
"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
application/json
JSON
{
"id": 0,
"pet": {
"id": 0,
"category": {
"id": 0,
"name": "string",
"sub": {
"prop1": "string"
}
},
"name": "Guru",
"photoUrls": [
],
"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"
]
}

Playground​

Server
Variables
Key
Value
Body
JSON

Samples​

cURL
JavaScript
PHP
Python

Delete user​

DELETE
/user/{username}

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

Playground​

Server
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

Creates list of users with given input array​

POST
/user/createWithArray

Request Body​

JSON
[
{
"id": 0,
"pet": {
"id": 0,
"category": {
"id": 0,
"name": "string",
"sub": {
"prop1": "string"
}
},
"name": "Guru",
"photoUrls": [
],
"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

Playground​

Server
Body
JSON

Samples​

cURL
JavaScript
PHP
Python

Creates list of users with given input array​

POST
/user/createWithList

Request Body​

JSON
[
{
"id": 0,
"pet": {
"id": 0,
"category": {
"id": 0,
"name": "string",
"sub": {
"prop1": "string"
}
},
"name": "Guru",
"photoUrls": [
],
"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

Playground​

Server
Body
JSON

Samples​

cURL
JavaScript
PHP
Python

Logs user into the system​

GET
/user/login

Parameters​

Query Parameters

username*

The user name for login

Typestring
Required
password*

The password for login in clear text

Typestring
Required

Responses​

successful operation
JSON
"OK"

Playground​

Server
Variables
Key
Value

Samples​

cURL
JavaScript
PHP
Python

Logs out current logged in user session​

GET
/user/logout

Responses​

successful operation

Playground​

Samples​

cURL
JavaScript
PHP
Python
Powered by VitePress OpenAPI