Laravel API explorer package

Laravel API explorer package

Laravel API explorer

Latest Version on Packagist Total Downloads

Interactive Laravel API explorer. You don’t need to write/update documentation for your API. On the fly, Your API documentation will always be available in an interactive way.


  • Quick install (one-step install, no code change needed);
  • Zero config needed;
  • Store config/parameters to be used anytime;
  • Variables: you can set variables (like id’s, tokens, etc. to be used in any place like querystring, header, body, etc.);
  • Global headers: You can set global headers (like tokens, content-type, etc.) to be used in all requests.

Live Demo

Using variables

You can click on top right icon (wrench) and add your variables. When you will need to set some querystring parameter, header value, body content, etc., you can use ${VARIABLE_NAME}, and this placeholder will be replaced by your variable.

Using global headers

If you API needs some header in all request (or almost), you can set global headers instead of create these headers for every request. You can click on top right icon (wrench) and add your global headers.


Routes list

Routes list

Route info

Route info



Response info

Response info


Via Composer

$ composer require netojose/laravel-api-explorer


You just need access


Optionally you can copy config file to override default package configuration

php artisan vendor:publish --provider="NetoJose\LaravelApiExplorer\LaravelApiExplorerServiceProvider"

Now you have a config/laravelapiexplorer.php file inside your project,and you can make your changes. Available configurations:

Configuration Description Default
enabled Determine if the explorer will available true
route The route to access explorer page api-explorer
match Pattern to routes to be available on explorer api/*
ignore Array of routes to be ignored. You can use a pattern of a route path or route name [,’/’,]


Please see for details and a todolist.


If you discover any security related issues, please email instead of using the issue tracker.


via Laravel News Links

December 9, 2019 at 09:00AM