PHPackages                             huy-tran/api-explorer-module - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. huy-tran/api-explorer-module

ActiveLaravel-module[API Development](/categories/api)

huy-tran/api-explorer-module
============================

Self-hosted API explorer for local development

v0.0.3(1mo ago)04↑2900%MITBladePHP ^8.4

Since Mar 27Pushed 1mo agoCompare

[ Source](https://github.com/huy-tran/api-explorer-module)[ Packagist](https://packagist.org/packages/huy-tran/api-explorer-module)[ RSS](/packages/huy-tran-api-explorer-module/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (3)Versions (4)Used By (0)

ApiExplorer 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
--------

[](#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
- ⚡ Zero-configuration setup for Laravel 12+ applications
- 🚀 Development-only module (production disabled)

Requirements
------------

[](#requirements)

- PHP 8.4+
- Laravel 12+
- `spatie/laravel-data` ^4.20
- `spatie/laravel-fractal` ^6.4
- `lorisleiva/laravel-actions` ^2.10

Installation
------------

[](#installation)

Install the module via Composer:

```
composer require huy-tran/api-explorer-module
```

The module will be automatically registered via the service provider.

Configuration
-------------

[](#configuration)

Publish the configuration file:

```
php artisan vendor:publish --provider="Modules\\ApiExplorer\\Providers\\ApiExplorerServiceProvider" --tag=config
```

This creates `config/api-explorer.php`:

```
return [
    'enabled' => env('API_EXPLORER_ENABLED', true),
    // Additional configuration options
];
```

The module is **disabled in production** and only available in development environments.

Publishing Assets
-----------------

[](#publishing-assets)

To publish views for customization:

```
php artisan vendor:publish --provider="Modules\\ApiExplorer\\Providers\\ApiExplorerServiceProvider" --tag=views
```

This publishes views to `resources/views/vendor/api-explorer/`.

Usage
-----

[](#usage)

### Scan API Endpoints

[](#scan-api-endpoints)

Scan your application for API endpoints:

```
php artisan api-explorer:scan
```

This command:

- Discovers all registered routes
- Analyzes action handlers and DTOs
- Generates documentation for your API
- Caches results for performance

### Clear Cache

[](#clear-cache)

Clear the API explorer cache:

```
php artisan api-explorer:clear-cache
```

### Access the Explorer

[](#access-the-explorer)

Once enabled, visit your application's API explorer route to browse documented endpoints.

Architecture
------------

[](#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

Environment Management
----------------------

[](#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
-------

[](#license)

This module is licensed under the MIT License.

Author
------

[](#author)

Huy Tran -

###  Health Score

38

—

LowBetter than 85% of packages

Maintenance90

Actively maintained with recent releases

Popularity5

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity43

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

3

Last Release

46d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/424f71b3bfa81f602dc05dce40c528a912870cb1ea1a07870aa144287bd863be?d=identicon)[hygo.tran](/maintainers/hygo.tran)

---

Top Contributors

[![huygreenhat](https://avatars.githubusercontent.com/u/89112825?v=4)](https://github.com/huygreenhat "huygreenhat (6 commits)")

---

Tags

apilaraveldevelopmentexplorer

### Embed Badge

![Health badge](/badges/huy-tran-api-explorer-module/health.svg)

```
[![Health](https://phpackages.com/badges/huy-tran-api-explorer-module/health.svg)](https://phpackages.com/packages/huy-tran-api-explorer-module)
```

###  Alternatives

[infyomlabs/routes-explorer

Laravel Routes Explorer

3925.6k](/packages/infyomlabs-routes-explorer)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)