juststeveking/laravel-stoplight-elements

A simple API documentation package for Laravel using OpenAPI and Stoplight Elements

3.0.0 2024-03-13 09:47 UTC

Requires

• php: ^7.4|^8.0|^8.1|^8.2|^8.3
• illuminate/support: ^8.0|^9.0|^10.0|^11.0

Requires (Dev)

• orchestra/testbench: ^9
• phpunit/phpunit: ^10

MIT

• Steve McDougall

• documentation
• api
• laravel
• openapi
• stoplight
• stoplight elements

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-stoplight-elements

Configuration

You can publish the configuration file with:

php artisan vendor:publish --provider="JustSteveKing\Laravel\LaravelStoplight\StoplightServiceProvider" --tag="config"

This is the contents of the published config file:

return [
    'title' => 'API Documentation',
    'path' => [
        'name' => env('STOPLIGHT_PATH_NAME', 'docs'),
        'url' => env('STOPLIGHT_PATH_URL', 'api/docs'),
    ],

    'openapi' => [
        'path' => env('STOPLIGHT_OPENAPI_PATH', 'https://api.apis.guru/v2/specs/github.com/1.1.4/openapi.yaml')
    ],

    'config' => [
        'router' => "hash",

        'layout' => "sidebar",
    ]
];

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
• Stoplight Team for the Elements Web Components

License

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