OpenAPI

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

Create a new user

POST /users

<Description of the endpoint>

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Description
name	string	Name of the user
age	number	Age of the user

Response

200

{
  "id": 1,
  "name": "John",
  "age": 30
}

400

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.

Required scopes

This endpoint requires the following scopes:

• : modify pets in your account
• : read your pets

Authorizations

petstore_auth

OAuth2implicitRequired

Authorization URL:

Body

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

idinteger · int64OptionalExample: 10

namestringRequiredExample: doggie

photoUrlsstring[]Required

statusstring · enumOptional

pet status in the store

Possible values:

Responses

200

Successful operation

application/jsonapplication/xml

idinteger · int64OptionalExample: 10

namestringRequiredExample: doggie

photoUrlsstring[]Required

statusstring · enumOptional

pet status in the store

Possible values:

400

Invalid input

422

Validation exception

default

Unexpected error

post

/pet

HTTPcURLJavaScriptPython

POST /api/v3/pet HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 133

{
  "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

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