playground-y

OpenAPI Playground Generator

Generate beautiful, interactive API playgrounds from OpenAPI specifications.

DEMO

https://coingecko-y.vercel.app/

Quick Start

Prerequisites:

• Node.js 18+

Generate a playground instantly:

npx playground-y <spec-file> <output-directory>

Example:

npx playground-y examples/coingecko-spec.json my-playground
cd my-playground
pnpm install
pnpm dev

Usage

Installation (Optional)

You can install the CLI globally for repeated use:

npm install -g playground-y

Generate Playground

playground-y <spec-path> <output-path> [options]

Available Aliases:

• playground-y
• playgroundy
• pgy
• openapi-playground

Options:

• --force: Force overwrite of existing output directory
• --api-key KEY: Pre-configure API key (stores in .env, hides auth field from users)
• --theme THEME: Set default theme (light, dark, or coffee)
• --workspace-image URL|FILE: Workspace logo/image
• --no-interactive: Skip interactive prompts

Features

✨ Beautiful UI - Modern, responsive design with light/dark/coffee themes
⚡ Fast - TypeScript generator is ~10x faster than alternatives
🎯 Type-safe - Full TypeScript support throughout
🎨 Customizable - Themes, branding, and configuration via x-ui-config
📝 OpenAPI 3.x - Full support with intelligent defaults
🚀 Production ready - Generates Next.js 16 apps

Migration from Python

The generator is now TypeScript-based! The Python generator has been retired in favor of a faster, more maintainable TypeScript implementation.

If you have existing workflows, simply replace:

# Old (Python)
python generate.py spec.json output

# New (TypeScript) 
npx playground-y spec.json output

All features are maintained with improved performance.

Contributing

See CONTRIBUTING.md for guidelines.

License

MIT