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.
Body
idinteger · int64optionalExample: 10
namestringrequiredExample: doggie
photoUrlsstring[]required
statusstring · enumoptionalAvailable options: 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"
}'