Skip to content

Swagger Petstore (1.0.0)

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.

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

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.
Download OpenAPI description
petstore.json
petstore.yaml
Overview
URL

https://github.com/Redocly/redoc

API Support

apiteam@swagger.io

License

Apache 2.0

Terms of Service

Languages
Servers
Mock server

https://innovario.apishowdown.com/_mock/petstore/

Default server

https://petstore.swagger.io/v2/

Sandbox server

https://petstore.swagger.io/sandbox/

pet

Everything about your Pets

Operations

store

Access to Petstore orders

Operations

Returns pet inventories by status

Request

Returns a map of status codes to quantities

Security
api_key
curl -i -X GET \
  https://innovario.apishowdown.com/_mock/petstore/store/inventory \
  -H 'api_key: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/json
property name*integer(int32)additional property
Response
application/json
{
  "property1": 0,
  "property2": 0
}

Place an order for a pet

Request

Bodyapplication/jsonrequired

order placed for purchasing the pet

quantityinteger(int32)>= 1
Default 1
shipDatestring(date-time)

Estimated ship date

statusstring

Order Status

Enum"placed""approved""delivered"
requestIdstringwrite-only

Unique Request Id

curl -i -X POST \
  https://innovario.apishowdown.com/_mock/petstore/store/order \
  -H 'Content-Type: application/json' \
  -d '{
    "quantity": 1,
    "shipDate": "2019-08-24T14:15:22Z",
    "status": "placed",
    "requestId": "string"
  }'

Responses

successful operation

Body
idinteger(int64)(Id)read-only

Order ID

petIdinteger(int64)(Id)read-only

Pet ID

quantityinteger(int32)>= 1
Default 1
shipDatestring(date-time)

Estimated ship date

statusstring

Order Status

Enum"placed""approved""delivered"
completebooleanread-only

Indicates whenever order was completed or not

Default false
Response
{
  "id": 0,
  "petId": 0,
  "quantity": 1,
  "shipDate": "2019-08-24T14:15:22Z",
  "status": "placed",
  "complete": false
}

Find purchase order by ID

Request

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

Path
orderIdinteger(int64)[ 1 .. 5 ]required

ID of pet that needs to be fetched

curl -i -X GET \
  'https://innovario.apishowdown.com/_mock/petstore/store/order/{orderId}'

Responses

successful operation

Body
idinteger(int64)(Id)read-only

Order ID

petIdinteger(int64)(Id)read-only

Pet ID

quantityinteger(int32)>= 1
Default 1
shipDatestring(date-time)

Estimated ship date

statusstring

Order Status

Enum"placed""approved""delivered"
completebooleanread-only

Indicates whenever order was completed or not

Default false
Response
{
  "id": 0,
  "petId": 0,
  "quantity": 1,
  "shipDate": "2019-08-24T14:15:22Z",
  "status": "placed",
  "complete": false
}

webhooks

Everything about your Webhooks

Webhooks

user

Operations about user

Operations