VitePress OpenAPI

Appearance

v1.0.0

Example of an OpenAPI document different schemas​

Get a parent​

GET
/circular-reference

Example of a JSON object with a circular reference.

Responses​

A parent with a child
application/json
JSON
{
"id": "string",
"child": {
"id": "string",
"parent": "[Circular Reference]"
}
}

Playground​

Samples​

cURL
JavaScript
PHP
Python

Get the root object​

GET
/multiple-levels

Example of a JSON object with multiple levels.

Responses​

Example of a deeply nested structure
application/json
JSON
{
"id": "string",
"level2": {
"id": "string",
"level3": {
"id": "string",
"level4": {
"id": "string",
"level5": {
"id": "string",
"level6": {
"id": "string",
"level7": {
"id": "string",
"level8": {
"id": "string",
"level9": {
"id": "string",
"level10": {
"id": "string",
"level11": {
"id": "string",
"level12": {
"id": "string",
"level13": {
"id": "string",
"level14": {
"id": "string",
"level15": {
"id": "string",
"level16": {
"id": "string",
"level17": {
"id": "string",
"level18": {
"id": "string",
"level19": {
"id": "string",
"level20": {
"id": "string",
"finalValue": "string"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}

Playground​

Samples​

cURL
JavaScript
PHP
Python

Get a string​

GET
/primitive-string

Example of a JSON object with a string.

Responses​

A string
application/json
JSON
"Hello, World!"

Playground​

Samples​

cURL
JavaScript
PHP
Python

Get a number​

GET
/primitive-number

Example of a JSON object with a number.

Responses​

A number
application/json
JSON
42

Playground​

Samples​

cURL
JavaScript
PHP
Python

Get a boolean​

GET
/primitive-boolean

Example of a JSON object with a boolean.

Responses​

A boolean
application/json
JSON
true

Playground​

Samples​

cURL
JavaScript
PHP
Python

Get a nullable object​

GET
/nullable-object

Example of a JSON object that can be null.

Responses​

A nullable object
application/json
JSON
{
"id": "string",
"name": "string",
"description": "string"
}

Playground​

Samples​

cURL
JavaScript
PHP
Python

Get a tuple array with prefixItems​

GET
/tuple-array

Example of a JSON array with prefixItems defining a tuple structure.

Responses​

A tuple array with fixed positions
application/json
JSON
[
"username",
42,
true,
{
"id": "abc123",
"value": 99.5
},
[
[
"tag1",
"tag2",
"tag3"
]
]
]

Playground​

Samples​

cURL
JavaScript
PHP
Python

Get a mixed array with prefixItems and items​

GET
/mixed-array

Example of a JSON array with both prefixItems and items schemas.

Responses​

An array with fixed positions followed by additional items
application/json
JSON
[
"user-id-123",
{
"name": "John Doe",
"role": "string"
},
{
"timestamp": "2023-01-15T14:30:00Z",
"value": 42.5,
"tags": [
[
"important",
"reviewed"
]
]
}
]

Playground​

Samples​

cURL
JavaScript
PHP
Python
Powered by VitePress OpenAPI