3sidedcube / laravel-redoc
A lightweight package for rendering API documentation using OpenAPI and Redoc.
Installs: 19 982
Dependents: 1
Suggesters: 0
Security: 0
Stars: 5
Watchers: 3
Forks: 2
Open Issues: 1
Requires
- php: ^7.4|^8.0|^8.1|^8.2|^8.3
- illuminate/routing: ^8.0|^9.0|^10.0|^11.0
- illuminate/support: ^8.0|^9.0|^10.0|^11.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.3
- orchestra/testbench: ^6.0|^7.0|^8.0|^9.0
README
Laravel Redoc
This package provides an easy way for rendering API documentation using OpenAPI and Redoc.
Installation
You can install the package via composer:
composer require 3sidedcube/laravel-redoc
Usage
Viewing the documentation
By default, the documentation is served at /docs/api and will load the openapi.json file from the openapi folder
at the root of the project.
You can change the path used to serve the documentation by setting the redoc.path config option.
If you would like to change the directory where your openapi.json file is located, you can update redoc.directory
config option.
Documentation versions
Laravel Redoc supports rendering multiple versions of documentation. If you would like to serve a different version of
the documentation, you can include {version} in the redoc.path config option e.g. docs/{version}/api. This will
then load the {version}.json file from the configured directory.
Variables
If you would like to replace a "variable" in the documentation, you can use the redoc.variables config option.
For example, if you would like to dynamically set the server url to the given environment, you could configure the following variable:
'variables' => [ 'server_url' => env('APP_URL'), ],
Now, when you use :server_url in the OpenAPI definition, it will be replaced with the value of the APP_URL.
Testing
composer test
Changelog
Please see CHANGELOG for more information what has changed recently.
Contributing
Please see CONTRIBUTING for details.
Credits
License
Laravel Redoc is open-sourced software licensed under the MIT license.