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 · int64

Example: 10

namestringrequired

Example: doggie

categoryobject

photoUrlsstring[]required

tagsobject[]

statusstring · enum

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": [
      "text"
    ],
    "tags": [
      {
        "id": 1,
        "name": "text"
      }
    ],
    "status": "available"
  }'

200

405

200

application/xml

application/json

application/xml

<?xml version="1.0"?>
<pet>
	<id>10</id>
	<name>doggie</name>
	<category>
		<id>1</id>
		<name>Dogs</name>
	</category>
	<photoUrls>
		<photoUrl>text</photoUrl>
	</photoUrls>
	<tags>
		<tag>
			<id>1</id>
			<name>text</name>
		</tag>
	</tags>
	<status>available</status>
</pet>

Successful operation