README

TR | EN

English

REST Explorer is a premium, lightweight, and modern API documentation and testing tool for Laravel applications. It automatically discovers your API routes and provides a beautiful interface to explore and test them directly from your browser.

✨ Features

• Auto Route Discovery: Automatically detects all api routes and groups them by controller.
• Interactive UI: A sleek, dark-themed interface built with Tailwind CSS and Inter typography.
• Sidebar Controller Navigation: Quickly jump between different API groups with hierarchical navigation.
• Postman Integration: Download your entire API collection as a Postman-compatible JSON file with one click.
• Smart Authentication: Persistent authorization token storage with a real-time status indicator.
• Live Testing: Execute requests (GET, POST, PUT, DELETE, PATCH) directly with a built-in "Try it out" feature.
• JSON Prettifier: Automatically formats request bodies and responses for better readability.
• Validation Rules: View FormRequest validation rules directly on the endpoint card.

🚀 Installation

1. Install the package via composer:

composer require cemtekin/rest-explorer

1. Publish the assets (optional):

php artisan vendor:publish --tag=rest-explorer-views

1. Access the explorer in your browser:

http://your-app.test/rest-explorer

Türkçe

REST Explorer, Laravel uygulamaları için geliştirilmiş, şık ve modern bir API dokümantasyon ve test aracıdır. API rotalarınızı otomatik olarak tarar ve doğrudan tarayıcı üzerinden test edebileceğiniz bir arayüz sunar.

✨ Özellikler

• Otomatik Rota Tarama: Tüm api rotalarını saptar ve controller bazlı gruplandırır.
• Etkileşimli Arayüz: Tailwind CSS ve Inter tipografisi ile hazırlanmış modern karanlık tema.
• Hiyerarşik Navigasyon: Sol menü üzerinden controller'lar arasında hızlıca geçiş yapma.
• Postman Entegrasyonu: Tüm API koleksiyonunuzu tek tıkla Postman uyumlu JSON olarak indirin.
• Akıllı Kimlik Doğrulama: Kalıcı token saklama ve gerçek zamanlı durum göstergesi.
• Canlı Test Paneli: GET, POST, PUT, DELETE, PATCH isteklerini doğrudan arayüzden çalıştırın.
• JSON Formatlayıcı: İstek gövdelerini ve yanıtları daha okunabilir hale getirmek için otomatik formatlama.
• Doğrulama Kuralları: FormRequest doğrulama kurallarını doğrudan endpoint kartı üzerinde görün.

🚀 Kurulum

1. Paketi composer ile yükleyin:

composer require cemtekin/rest-explorer

1. Görünümleri yayınlayın (isteğe bağlı):

php artisan vendor:publish --tag=rest-explorer-views

1. Tarayıcınızdan explorer'a erişin:

http://your-app.test/rest-explorer