OpenAPI

You can sync GitBook pages with an OpenAPI or Swagger file or a URL to include auto-generated API methods in your documentation.

OpenAPI block

GitBook's OpenAPI block is powered by Scalar, so you can test your APIs directly from your docs.

Add a new pet to the store.

post

Add a new pet to the store.

Authorizations

Body

application/jsonapplication/xmlapplication/x-www-form-urlencoded

idinteger · int64optional

Example: 10

namestringrequired

Example: doggie

categoryobjectoptional

photoUrlsstring[]required

tagsobject[]optional

statusstring · enumoptional

pet status in the store

Available options:

Responses

application/jsonapplication/xml

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/api/v3/pet' \
  --header 'Content-Type: application/json' \
  --data '{
    "id": 10,
    "name": "doggie",
    "category": {
      "id": 1,
      "name": "Dogs"
    },
    "photoUrls": [
      "text"
    ],
    "tags": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "status": "available"
  }'

application/jsonapplication/xmlapplication/x-www-form-urlencoded

200

400

422

default

200

application/json

application/xml

application/json

{
  "id": 10,
  "name": "doggie",
  "category": {
    "id": 1,
    "name": "Dogs"
  },
  "photoUrls": [
    "text"
  ],
  "tags": [
    {
      "id": 1,
      "name": "text"
    }
  ],
  "status": "available"
}

Successful operation