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

Path Parameters

userId*

The ID of the user

Typestring

Required

Example123

Query Parameters

age

The age of the user to filter

Typeinteger

Example25

acceptsCookies*

Whether the user accepts cookies

Typeboolean

Required

Exampletrue

isSubscribed

Whether the user is subscribed to the newsletter

Typeboolean

Examplefalse

Responses

Successful response

Content-Type

application/json

{

"userId": "string",

"name": "string",

"age": 0

}

GET

/users/{userId}

Samples

---

Powered by VitePress OpenAPI