ensi / laravel-serve-stoplight
Laravel serve stoplight
Installs: 32 916
Dependents: 0
Suggesters: 0
Security: 0
Stars: 2
Watchers: 2
Forks: 2
Open Issues: 0
Requires
- php: ^8.1
- laravel/framework: ^9.0 || ^10.0 || ^11.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.2
- orchestra/testbench: ^7.0 || ^8.0 || ^9.0
- pestphp/pest: ^1.22 || ^2.0
- pestphp/pest-plugin-laravel: ^1.1 || ^2.0
- phpstan/extension-installer: ^1.3
- phpstan/phpstan: ^1.11
- spaze/phpstan-disallowed-calls: ^2.15
README
The package allows you to output the Stoplight UI by configuring only the paths to your openapi3 configs
Based on stoplight/elements
Installation
You can install the package via composer:
composer require ensi/laravel-serve-stoplight
Publish config file like this:
php artisan vendor:publish --provider="Ensi\LaravelServeStoplight\ServeStoplightServiceProvider"
Configure config/serve-stoplight.php
Version Compatibility
Basic usage
By default, the v1 specification is available at docs/oas (the same full path as docs/oas/v1).
If you need to open a specification of another version, use the docs/os/{version} path, for example, docs/os/v2
Contributing
Please see CONTRIBUTING for details.
Update stoplight
For update stoplight:
- update
stoplight-resources/web-components.min.jsfrom https://unpkg.com/@stoplight/elements/web-components.min.js - update
stoplight-resources/styles.min.cssfrom https://unpkg.com/@stoplight/elements/styles.min.css - update current Stoplight version on
Version Compatibility
Testing
- composer install
- composer test
Security Vulnerabilities
Please review our security policy on how to report security vulnerabilities.
License
The MIT License (MIT). Please see License File for more information.