Download the PHP package muammarsiddiqui/apideck-laravel without Composer
On this page you can find all versions of the php package muammarsiddiqui/apideck-laravel. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download muammarsiddiqui/apideck-laravel
More information about muammarsiddiqui/apideck-laravel
Files in muammarsiddiqui/apideck-laravel
Package apideck-laravel
Short Description Lightweight, beautiful, zero-config API playground and explorer for Laravel APIs
License MIT
Informations about the package apideck-laravel
apideck-laravel
Lightweight, beautiful, zero-config API playground and explorer for Laravel APIs.
ApiDeck automatically inspects your Laravel routes and controllers to generate a stunning UI allowing you to browse, test, and document your API without writing manual OpenAPI YAML files or docblocks.
Features
- Zero Config: Just require the package and visit
/apideck. - Dynamic Schema Reflection: ApiDeck uses PHP Reflection to automatically read your type-hinted Controller parameters (DTOs, FormRequests) and generate JSON examples in the UI!
- Modern UI: Sleek, fully responsive, dark-mode ready interface.
- Native Integration: Seamlessly integrates with Laravel's internal router.
Installation
Install the package via Composer:
Because of Laravel's package auto-discovery, the service provider will be registered automatically!
Quick Start
You don't need to do anything. Simply define your routes in routes/api.php or routes/web.php:
Then open http://localhost:8000/apideck in your browser!
(Note: ApiDeck automatically filters out routes that don't belong to your API to keep the interface clean).
Advanced: Dynamic Schema Reflection (Auto-Example Generation)
ApiDeck features a powerful PHP Reflection engine. If you want ApiDeck to automatically generate Example JSON payloads and field schemas in the UI for your POST/PUT requests, all you have to do is strongly type-hint your controller methods or route closures!
Using a DTO / Class
If you type-hint a custom class, ApiDeck will read its public properties:
Using Form Requests
If you type-hint a standard Laravel FormRequest, ApiDeck will try to instantiate it and parse its rules() array to map out the fields:
ApiDeck will automatically reflect on these injected parameters and display fully populated JSON example payloads in the interface!
Configuration (Optional)
If you need to change the base URL or other behavior, publish the config file:
All versions of apideck-laravel with dependencies
illuminate/support Version ^9.0|^10.0|^11.0|^12.0
illuminate/routing Version ^9.0|^10.0|^11.0|^12.0
illuminate/http Version ^9.0|^10.0|^11.0|^12.0