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

Add a new pet to the store

post

/pet

Authorizations

Body

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

idinteger int64

Example: 10

namestringrequired

Example: doggie

categoryobject

photoUrlsstring[]required

tagsobject[]

statusenum

pet status in the store

Options: available, pending, sold

Responses

application/xmlapplication/json

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":[null],"tags":[{}],"status":"available"}'

200

405

200

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

Successful operation