Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/netojose/laravel-api-explorer
API explorer for laravel applications
https://github.com/netojose/laravel-api-explorer
api api-client laravel laravel-package php react
Last synced: about 4 hours ago
JSON representation
API explorer for laravel applications
- Host: GitHub
- URL: https://github.com/netojose/laravel-api-explorer
- Owner: netojose
- License: other
- Created: 2018-07-25T14:04:09.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-11T18:34:02.000Z (about 1 month ago)
- Last Synced: 2024-10-21T03:02:08.927Z (26 days ago)
- Topics: api, api-client, laravel, laravel-package, php, react
- Language: JavaScript
- Size: 2.94 MB
- Stars: 144
- Watchers: 9
- Forks: 25
- Open Issues: 8
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
- License: license.md
Awesome Lists containing this project
README
# Laravel API explorer
[![Latest Version on Packagist][ico-version]][link-packagist]
[![Total Downloads][ico-downloads]][link-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.
## 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
![Routes list][screenshot-1]
### Route info
![Route info][screenshot-2]
### Request/response
![Request/response][screenshot-3]
### Response info
![Response info][screenshot-4]
## Installation
Via Composer
```bash
$ 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
```bash
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](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.
[ico-version]: https://img.shields.io/packagist/v/netojose/laravel-api-explorer.svg?style=flat-square
[ico-downloads]: https://img.shields.io/packagist/dt/netojose/laravel-api-explorer.svg?style=flat-square
[link-packagist]: https://packagist.org/packages/netojose/laravel-api-explorer
[link-downloads]: https://packagist.org/packages/netojose/laravel-api-explorer
[link-author]: https://netojose.github.io
[screenshot-1]: https://i.imgur.com/MA27Djs.png "Routes list"
[screenshot-2]: https://i.imgur.com/lZrCPUz.png "Route info"
[screenshot-3]: https://i.imgur.com/dfXlxiV.png "Request/response"
[screenshot-4]: https://i.imgur.com/ApPO9Au.png "Response info"