Package
laravel-redoc
A simple API documentation package for Laravel using OpenAPI and Redoc
2.1.0358,365 downloads92 stars
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.
Related
More Packages
Same subject
In other formats
Automating your OpenAPI Documentation
Learn to automate API documentation in Laravel with a design-first approach using OpenAPI, Scribe, and efficient pagination in this practical tutorial.
API Design
VideoBuilding an API using API Platform and OpenAPI
Join us for an in-depth livestream as we explore the world of API development using API Platform and OpenAPI. With special guest Jim Secondé from Vonage, we'll be diving deep into the intricacies of A
API Design