v1.0.0

Playground Examples API

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

API to demonstrate the use of x-playground-example extension

Servers

https://api.example.com/v1Production server

---

Default

Operations

GET/itemsPOST/itemsGET/items/{id}

---

List items with playground-specific examples

GET

/items

Demonstrates the use of x-playground-example extension.

Parameters

Header Parameters

X-Custom

Optionally provide parameters as a JSON object in this header.

Typestring

Example"{\"id\":\"header-id-789\"}"

X-Api-Key*

API key for authentication

Typestring

Required

Example"api-key-123"

Query Parameters

id

Filter by ID (with playground-specific example)

Typestring

Example"general-id-456"

name

Filter by name (with schema-level playground example)

Typestring

Example"General Item Name"

category

Filter by category (with standard example)

Typestring

Example"electronics"

Responses

Successful response

Content-Type

application/json

object

object[]

GET

/items

Playground

Headers

X-Custom

X-Api-Key*

Variables

Key

Value

id

name

category

Samples

cURL

JavaScript

PHP

Python