VitePress OpenAPI

Appearance

v1.0.0

Example of an OpenAPI document different schemas​

ID: getCircularReference

Get a parent​

Default
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]"
}
}

Samples​

ID: getMultipleLevels

Get the root object​

Default
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"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}

Samples​

ID: getPrimitiveString

Get a string​

Default
GET
/primitive-string

Example of a JSON object with a string.

Responses​

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

Samples​

ID: getPrimitiveNumber

Get a number​

Default
GET
/primitive-number

Example of a JSON object with a number.

Responses​

A number
application/json
JSON
42

Samples​

ID: getPrimitiveBoolean

Get a boolean​

Default
GET
/primitive-boolean

Example of a JSON object with a boolean.

Responses​

A boolean
application/json
JSON
true

Samples​

Powered by VitePress OpenAPI