https://github.com/madrasly/madrasly

Auto-generate interactive API playgrounds from OpenAPI specs. Get developers calling your API in seconds.
https://github.com/madrasly/madrasly

api docs documentation open-source openapi openapi-specification openapi3 openapi31 playground rest-api sandbox

Last synced: 26 days ago
JSON representation

Auto-generate interactive API playgrounds from OpenAPI specs. Get developers calling your API in seconds.

• Host: GitHub
• URL: https://github.com/madrasly/madrasly
• Owner: madrasly
• License: mit
• Created: 2025-11-17T22:09:23.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2025-11-24T17:03:05.000Z (7 months ago)
• Last Synced: 2026-01-13T19:26:04.837Z (5 months ago)
• Topics: api, docs, documentation, open-source, openapi, openapi-specification, openapi3, openapi31, playground, rest-api, sandbox
• Language: TypeScript
• Homepage: https://madrasly.com
• Size: 732 KB
• Stars: 17
• Watchers: 0
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![npm downloads](https://img.shields.io/npm/dm/madrasly) ![npm version](https://img.shields.io/npm/v/madrasly) ![GitHub stars](https://img.shields.io/github/stars/madrasly/madrasly?style=social) ![GitHub forks](https://img.shields.io/github/forks/madrasly/madrasly) ![License](https://img.shields.io/github/license/madrasly/madrasly)

# OpenAPI Playground Generator

Generate beautiful, interactive API playgrounds from OpenAPI specifications.





## DEMO

[DEMO](https://madrasly-hero-demo.vercel.app/)

## Quick Start

**Prerequisites:**

- Node.js 18+

**Generate a playground instantly:**

```bash

npx madrasly  

```

**Example:**

```bash

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:

```bash

npm install -g madrasly

```

### Generate Playground

```bash

madrasly   [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](CONTRIBUTING.md) for guidelines.

## License

MIT