theobaidur / laravel-api-explorer

API explorer for laravel applications

Laravel API explorer

This is where your description should go. Take a look at contributing.md to see a to do list.

Features

• Quick install (one-step install, no code change needed)
• Store config/parameters to be used anytime
• Global headers: You can set global headers (like tokens, content-type, etc.) to be used in all requests

Screenshots

Routes list

Route info

Request/response

Response info

Installation

Via Composer

$ composer require netojose/laravel-api-explorer

Usage

You just need access yourdomain.com/api-explorer

Configuration

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	[,'/',]

Contributing

Please see contributing.md for details and a todolist.

Security

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