juststeveking/laravel-redoc
A simple API documentation package for Laravel using OpenAPI and Redoc
Laravel Redoc
Easily publish your API documentation using your OpenAPI document in your Laravel Application.
Installation
You can install this package via composer:
composer require juststeveking/laravel-redocEnabling Alfred
To enable Alfred on your docs, visit: https://www.treblle.com/product/alfred or https://docs.treblle.com/treblle/ai-assistant
Configuration
You can publish the configuration file with:
php artisan vendor:publish --provider="JustSteveKing\Laravel\LaravelRedoc\RedocServiceProvider" --tag="config"This is the contents of the published config file:
return [ 'path' => [ 'name' => env('REDOC_PATH_NAME', 'docs'), 'url' => env('REDOC_PATH_URL', 'api/docs'), ],
'alfred' => [ 'enabled' => env('REDOC_ALFRED', true), 'project_id' => env('ALFRED_PROJECT_ID', null), 'api_key' => env('ALFRED_API_KEY', null), ],
'openapi' => [ 'path' => env('REDOC_OPENAPI_PATH', 'http://petstore.swagger.io/v2/swagger.json') ],
'config' => [ 'search' => false,
'hostname' => false,
'loading' => false,
'menu' => true,
'scrollbars' => true,
'trust' => true, ]];Contributing
Please see CONTRIBUTING and CODE_OF_CONDUCT for details.
Security
If you discover any security related issues, please email juststevemcd@gmail.com instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.
More Packages
juststeveking/companies-house-laravel
A Laravel wrapper to get companies house information and validate company numbers
v1.2.0
PHPjuststeveking/gtin-php
A PHP package for validating GTIN codes
v1.0.1
PHPjuststeveking/http-auth-strategies
A simple PHP package that is used to create different Http Auth Headers
v1.2.0