A simple API documentation package for Laravel using OpenAPI and Redoc
juststeveking/laravel-redoc is a Laravel package for a simple api documentation package for laravel using openapi and redoc.
It currently has 92 GitHub stars and 304.222 downloads on Packagist (latest version 2.1.0).
Install it with composer require juststeveking/laravel-redoc.
Discover more Laravel packages by juststeveking
or browse all Laravel packages to compare alternatives.
Last updated
Easily publish your API documentation using your OpenAPI document in your Laravel Application.
You can install this package via composer:
composer require juststeveking/laravel-redoc
To enable Alfred on your docs, visit: https://www.treblle.com/product/alfred or https://docs.treblle.com/treblle/ai-assistant
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,
]
];
Please see CONTRIBUTING and CODE_OF_CONDUCT for details.
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
The MIT License (MIT). Please see License File for more information.
