Menu

Tree [d26d3c] main /
 History

HTTPS access


File Date Author Commit
 .github 2025-11-19 Samuel EF. Tinnerholm Samuel EF. Tinnerholm [2bb5fc] Update generate-example.yml
 examples 2025-11-24 GitHub Action GitHub Action [8665b7] chore: regenerate example playground
 src 2025-11-22 Samuel EF. Tinnerholm Samuel EF. Tinnerholm [c4ebf8] feat: improve endpoint configuration and parsing
 templates 2025-11-24 Samuel EF. Tinnerholm Samuel EF. Tinnerholm [06c481] fixed copy for AI button
 .gitattributes 2025-11-16 Samuel EF. Tinnerholm Samuel EF. Tinnerholm [eb1e0e] Initial commit
 .gitignore 2025-11-22 Samuel EF. Tinnerholm Samuel EF. Tinnerholm [86d834] chore: update .gitignore to exclude temp files
 .npmrc 2025-11-20 Samuel EF. Tinnerholm Samuel EF. Tinnerholm [bc9d60] Fix API playground layout and add madrasclear e...
 .nvmrc 2025-11-20 Samuel EF. Tinnerholm Samuel EF. Tinnerholm [bc9d60] Fix API playground layout and add madrasclear e...
 CONTRIBUTING.md 2025-11-20 Samuel EF. Tinnerholm Samuel EF. Tinnerholm [d54e68] rename to madrasly
 LICENSE 2025-11-16 Samuel EF. Tinnerholm Samuel EF. Tinnerholm [eb1e0e] Initial commit
 README.md 2025-11-24 Samuel EF. Tinnerholm Samuel EF. Tinnerholm [d26d3c] Added: shields
 SELF_DESTRUCT_BANNER.md 2025-11-20 Samuel EF. Tinnerholm Samuel EF. Tinnerholm [bc9d60] Fix API playground layout and add madrasclear e...
 THIRD-PARTY-LICENSES 2025-11-18 Samuel EF. Tinnerholm Samuel EF. Tinnerholm [1746da] Refactor OpenAPI parser to use @apidevtools/swa...
 package-lock.json 2025-11-20 Samuel EF. Tinnerholm Samuel EF. Tinnerholm [433d64] madras example
 package.json 2025-11-21 Samuel EF. Tinnerholm Samuel EF. Tinnerholm [df3b4b] Update package.json
 pnpm-lock.yaml 2025-11-19 Samuel EF. Tinnerholm Samuel EF. Tinnerholm [2b43b2] fixed some rendering issues
 tsconfig.json 2025-11-19 Samuel EF. Tinnerholm Samuel EF. Tinnerholm [13e24f] refactor: restructure repository to industry-st...
 watch.js 2025-11-21 Samuel EF. Tinnerholm Samuel EF. Tinnerholm [0447df] Update examples, generator, and configuration f...

Read Me

npm downloads npm version GitHub stars GitHub forks License

OpenAPI Playground Generator

Generate beautiful, interactive API playgrounds from OpenAPI specifications.

Screenshot 2025-11-18 at 3 26 08 PM Screenshot 2025-11-18 at 3 26 27 PM

DEMO

DEMO

Quick Start

Prerequisites:
- Node.js 18+

Generate a playground instantly:

npx madrasly <spec-file> <output-directory>

Example:

npx madrasly 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 madrasly

Generate Playground

madrasly <spec-path> <output-path> [options]

Available Aliases:
- madrasly
- madras

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
- --popular-endpoints ENDPOINTS: Comma-separated list of endpoints to display prominently

Contributing

See CONTRIBUTING.md for guidelines.

License

MIT