Download the PHP package netojose/laravel-api-explorer without Composer
On this page you can find all versions of the php package netojose/laravel-api-explorer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download netojose/laravel-api-explorer
More information about netojose/laravel-api-explorer
Files in netojose/laravel-api-explorer
Package laravel-api-explorer
Short Description API explorer for laravel application
License MIT
Homepage https://github.com/netojose/laravel-api-explorer
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 laravel-api-explorer
Laravel API explorer
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
Usage
You just need access yourdomain.com/api-explorer
Configuration
Optionally you can copy config file to override default package configuration
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.
