netojose / laravel-api-explorer
API explorer for laravel application
Installs: 31 694
Dependents: 0
Suggesters: 0
Security: 0
Stars: 144
Watchers: 9
Forks: 25
Open Issues: 8
Language:JavaScript
This package is auto-updated.
Last update: 2024-10-29 16:12:08 UTC
README
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.
Features
- 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
https://laravel-api-explorer-demo.herokuapp.com/api-explorer
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.
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:
Contributing
Please see contributing.md for details and a todolist.
Security
If you discover any security related issues, please email sputinykster@gmail.com instead of using the issue tracker.