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​

cURL
curl http://localhost/circular-reference \
  --header 'Content-Type: application/json'
JavaScript
fetch('http://localhost/circular-reference', {
  headers: {
    'Content-Type': 'application/json'
  }
})
PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://localhost/circular-reference",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
Python
import requests

url = "http://localhost/circular-reference"

headers = {"Content-Type": "application/json"}

response = requests.get(url, headers=headers)

print(response.json())
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​

cURL
curl http://localhost/multiple-levels \
  --header 'Content-Type: application/json'
JavaScript
fetch('http://localhost/multiple-levels', {
  headers: {
    'Content-Type': 'application/json'
  }
})
PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://localhost/multiple-levels",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
Python
import requests

url = "http://localhost/multiple-levels"

headers = {"Content-Type": "application/json"}

response = requests.get(url, headers=headers)

print(response.json())
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​

cURL
curl http://localhost/primitive-string \
  --header 'Content-Type: application/json'
JavaScript
fetch('http://localhost/primitive-string', {
  headers: {
    'Content-Type': 'application/json'
  }
})
PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://localhost/primitive-string",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
Python
import requests

url = "http://localhost/primitive-string"

headers = {"Content-Type": "application/json"}

response = requests.get(url, headers=headers)

print(response.json())
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​

cURL
curl http://localhost/primitive-number \
  --header 'Content-Type: application/json'
JavaScript
fetch('http://localhost/primitive-number', {
  headers: {
    'Content-Type': 'application/json'
  }
})
PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://localhost/primitive-number",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
Python
import requests

url = "http://localhost/primitive-number"

headers = {"Content-Type": "application/json"}

response = requests.get(url, headers=headers)

print(response.json())
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​

cURL
curl http://localhost/primitive-boolean \
  --header 'Content-Type: application/json'
JavaScript
fetch('http://localhost/primitive-boolean', {
  headers: {
    'Content-Type': 'application/json'
  }
})
PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://localhost/primitive-boolean",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
Python
import requests

url = "http://localhost/primitive-boolean"

headers = {"Content-Type": "application/json"}

response = requests.get(url, headers=headers)

print(response.json())
Powered by VitePress OpenAPI