VitePress OpenAPI

Appearance

v1.0.0

Parameter Testing API​

Example of an OpenAPI document with different types of parameters.

Servers​

https://api.example.com

Default​

Operations​

GET/users/{userId}
ID: get-users-{userId}

Get user information by ID​

Default
GET
/users/{userId}

Returns information for a specific user.

Parameters​

Header Parameters

X-Custom-Header

A custom header for testing purposes

Typestring
Examplecustom-value
minLength3
maxLength50
pattern^[a-zA-Z0-9-]+$

Path Parameters

userId*

The ID of the user

Typestring
Required
Example123

Query Parameters

age

The age of the user to filter

Typeinteger
Example25
minimum0
maximum120
multipleOf1
acceptsCookies*

Whether the user accepts cookies

Typeboolean
Required
Exampletrue
isSubscribed

Whether the user is subscribed to the newsletter

Typeboolean
Examplefalse

Responses​

Successful response
application/json
JSON
{
"userId": "string",
"name": "string",
"age": 0
}

Samples​

cURL
curl 'https://api.example.com/users/123?age=25&acceptsCookies=true&isSubscribed=false' \
  --header 'Content-Type: application/json' \
  --header 'X-Custom-Header: custom-value'
JavaScript
fetch('https://api.example.com/users/123?age=25&acceptsCookies=true&isSubscribed=false', {
  headers: {
    'Content-Type': 'application/json',
    'X-Custom-Header': 'custom-value'
  }
})
PHP
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/users/123",
  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",
    "X-Custom-Header: custom-value"
  ],
]);

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

curl_close($curl);

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

url = "https://api.example.com/users/123"

headers = {
    "Content-Type": "application/json",
    "X-Custom-Header": "custom-value"
}

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

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