README

Laravel Explorer

An advanced, beautiful, and interactive API route explorer and testing workspace for Laravel 12+.
Built with Tailwind CSS, it provides a Postman/Insomnia-like experience directly within your Laravel application.

📸 Preview

✨ Key Features

• Interactive API Testing: Send GET, POST, PUT, PATCH, and DELETE requests directly from your browser.
• Smart Parameter Detection: Automatically detects URL Path parameters and analyzes your Controller/Closure code via PHP Reflection to find expected Body/Query parameters.
• Advanced Authentication Handling: Seamlessly manage auth:sanctum or JWT tokens. Tokens are synced across the UI, persist in localStorage, and feature a secure visibility toggle.
• Built-in REPL Console: A fully functional JavaScript console to interact with HTML responses, complete with command history (Up/Down arrows) and log interception.
• Code Snippet Generator: Instantly generates ready-to-use cURL and Fetch API scripts for your endpoints.
• Visual & Raw Output: Toggle between a beautifully formatted, syntax-highlighted JSON tree, Raw output, or an interactive HTML iFrame preview.
• Native Dark/Light Mode: Automatically matches your system preference or toggles manually without any flickering (No FOUC).
• Secure by Default: Runs only in the local environment out of the box to prevent route and data leaks in production.

📦 Requirements

• PHP: ^8.2
• Laravel: ^12.0

🚀 Installation

You can install the package via composer. Since this is a developer tool, it is highly recommended to install it as a dev dependency:

composer require mevlutcelik/laravel-explorer --dev

🛠️ Usage

Once installed, simply start your Laravel development server:

php artisan serve

Then, visit the explorer in your browser: http://localhost:8000/explorer

⚙️ Configuration (Optional)

Laravel Explorer works perfectly out of the box. However, if you want to change the default route path, environments, or apply custom middleware, you can publish the configuration file:

php artisan vendor:publish --tag="laravel-explorer-config"

This will create a config/laravel-explorer.php file in your app:

return [
    /*
     * The path where the explorer will be accessible.
     */
    'path' => 'explorer',

    /*
     * The environments where the explorer is allowed to run.
     * For security reasons, this defaults to 'local' only.
     */
    'environments' => ['local'],

    /*
     * Middleware applied to the explorer route.
     */
    'middleware' => ['web'],
];

Note: If you modify the config file, remember to run php artisan config:clear.

🔒 Security Vulnerabilities

If you discover a security vulnerability within Laravel Explorer, please send an e-mail to Mevlüt Çelik via info@mevlutcelik.com. All security vulnerabilities will be promptly addressed.

👨‍💻 Credits

• Mevlüt Çelik
• All Contributors

📄 License

The MIT License (MIT). Please see License File for more information.