Client Collections & Specs

OpenAPI 3.1 & 3.0 Specification

Download the complete, schema-validated OpenAPI specification for Playground API. Generate typed frontend clients, TanStack Query hooks, or import directly into Swagger UI, Postman, and Insomnia in seconds.

OpenAPI 3.0.3playground-api.openapi.json

Full API Specification Export

Contains all 35+ REST endpoints, request/response models, query parameter definitions, bearer token schemes, and chaos simulation modifiers.

Download OpenAPI JSON

Resource-Filtered Slices

Need a focused specification for a specific domain? Append ?resource=:name:

Generate Typed Clients with OpenAPI Tools

Use standard open-source tools to turn the OpenAPI specification into type-safe client libraries:

openapi-ts-setup.sh

# 1. Generate full TypeScript schema types

npx openapi-typescript https://playground.nileslabs.com/api/v1/downloads/openapi.json -o ./src/types/api-schema.d.ts

# 2. Use in your application code:

import type { paths, components } from './src/types/api-schema';

type Post = components['schemas']['Post'];

type User = components['schemas']['User'];

OpenAPI Specification Schema Preview

openapi.json

{

"openapi": "3.0.3",

"info": {

"title": "Playground API",

"version": "1.0.0",

"description": "Zero-configuration stateful mock REST and GraphQL API."

"servers": [

{ "url": "https://playground.nileslabs.com/api/v1", "description": "Live Stateful Sandbox" }

"paths": {

"/posts": {

"get": {

"summary": "List blog posts",

"parameters": [

{ "name": "_limit", "in": "query", "schema": { "type": "integer", "default": 10 } },

{ "name": "_page", "in": "query", "schema": { "type": "integer", "default": 1 } },

{ "name": "q", "in": "query", "schema": { "type": "string" } }

]

"post": {

"summary": "Create stateful post"

}

Prefer testing with Postman?

Download the pre-configured Postman v2.1 collection with authentication scripts.

View Postman Collection

PreviousDevTools Extension

NextPostman Collection v2.1