JustSteveKing / laravel-redoc by JustSteveKing

A simple API documentation package for Laravel using OpenAPI and Redoc
68,715
63
3
Package Data
Maintainer Username: JustSteveKing
Maintainer Contact: juststevemcd@gmail.com (Steve McDougall)
Package Create Date: 2021-05-06
Package Last Update: 2024-04-24
Language: PHP
License: MIT
Last Refreshed: 2024-04-28 03:00:03
Package Statistics
Total Downloads: 68,715
Monthly Downloads: 4,095
Daily Downloads: 11
Total Stars: 63
Total Watchers: 3
Total Forks: 9
Total Open Issues: 1

Laravel Redoc

Latest Version on Packagist Software License Build Status Total Downloads

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

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'),
    ],

    '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.