Download the PHP package huy-tran/api-explorer-module without Composer
On this page you can find all versions of the php package huy-tran/api-explorer-module. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download huy-tran/api-explorer-module
More information about huy-tran/api-explorer-module
Files in huy-tran/api-explorer-module
Package api-explorer-module
Short Description Self-hosted API explorer for local development
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package api-explorer-module
ApiExplorer Module
A self-hosted API explorer for local development in Laravel applications. Automatically scans and documents your API routes, actions, and DTOs.
Features
- Automatic API route discovery and documentation
- Inspect action handlers and their data structures
- View request/response schemas from DTOs and transformers
- Manage multiple environment configurations
- Per-endpoint state persistence with URL-based restoration
- Fuzzy search across all endpoints
- Fake data generation for request testing
- Dark mode support
- Zero-configuration setup for Laravel 12+ applications
- Development-only module (production disabled)
Tech Stack
Backend
- PHP 8.3+
- Laravel 12+ (module architecture)
- spatie/laravel-data ^3|^4 — DTO schemas and validation
- lorisleiva/laravel-actions ^2.0 — Action-based route handlers
Frontend
- Alpine.js 3.x — Reactive UI components
- Tailwind CSS — Utility-first styling (CDN)
- Fuse.js — Fuzzy search for endpoint filtering
- Faker.js 8.3.1 — Fake data generation for request fields
- Font Awesome 6.5.1 — Icons
- Blade — Server-side templating
All frontend assets are loaded via CDN — no build step required.
Requirements
- PHP 8.3+
- Laravel 12+
spatie/laravel-data^3|^4lorisleiva/laravel-actions^2.0
Installation
Install the module via Composer:
The module will be automatically registered via the service provider.
Configuration
Publish the configuration file:
This creates config/api-explorer.php:
| Option | Default | Description |
|---|---|---|
enabled |
true |
Enable or disable the module |
cache |
true |
Cache scanned API data |
cache_ttl |
86400 |
Cache time-to-live in seconds |
route_prefix |
dev/api-explorer |
URL prefix for the explorer routes |
exclude_patterns |
[...] |
Route patterns to exclude from scanning |
The module is disabled in production and only available in development environments.
Publishing Assets
To publish views for customization:
This publishes views to resources/views/vendor/api-explorer/.
Usage
Scan API Endpoints
Scan your application for API endpoints:
This command:
- Discovers all registered routes
- Analyzes action handlers and DTOs
- Generates documentation for your API
- Caches results for performance
Clear Cache
Clear the API explorer cache:
Access the Explorer
Once enabled, visit your application's API explorer route to browse documented endpoints.
Architecture
The module uses several key components:
- RouteScanner - Discovers and analyzes Laravel routes
- ActionResolver - Inspects Laravel Action handlers
- DtoInspector - Extracts schemas from spatie/laravel-data DTOs
- EndpointPipeline - Processes and enriches endpoint information
- FieldTypeMapper - Maps PHP types to readable schema types
DTO Integration
Scalar and Enum Properties
Standard PHP types are automatically mapped to form fields:
| PHP Type | Input Type |
|---|---|
string |
Text |
int, float |
Number |
bool |
Checkbox |
array |
Repeatable text items |
mixed |
Textarea |
Carbon, DateTime |
Datetime picker |
UploadedFile |
File upload |
BackedEnum |
Select dropdown |
Nested Data class |
Expandable group |
Eloquent Model Properties
Eloquent model parameters in DTOs are automatically rendered as body ID fields using a convention-based key derived from the class name:
| Model class | Auto-derived key | Input type |
|---|---|---|
Client |
clientId |
number |
ClientProject |
clientProjectId |
number |
DocumentChunk |
documentChunkId |
number |
No annotation is required for the common case:
Overriding with #[BodyField]
Use #[BodyField] when the default key or input type doesn't fit:
Parameters:
| Parameter | Type | Default | Description |
|---|---|---|---|
$key |
string |
— | The field name sent in the request body |
$inputType |
string |
'number' |
Input type rendered in the UI. Use 'text' for UUID-keyed models |
Environment Management
Store and switch between multiple API environments:
- Save environment configurations
- Switch between development, staging, and production endpoints
- Store authentication tokens and custom headers per environment
License
This module is licensed under the MIT License.
Author
Huy Tran - [email protected]
