juststeveking/laravel-redoc

A simple API documentation package for Laravel using OpenAPI and Redoc

2.1.0 2024-06-11 09:25 UTC

Requires

• php: ^8.0
• illuminate/support: ^10.0|^11.0

Requires (Dev)

• orchestra/testbench: ^8.0
• phpunit/phpunit: ^9.5

MIT

• Steve McDougall

• documentation
• api
• laravel
• openapi
• redoc

README

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-redoc

Enabling 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 [e-mail] instead of using the issue tracker.

Credits

• Steve McDougall
• All Contributors
• Redocly Team for their open source tool redoc

License

The MIT License (MIT). Please see License File for more information.