README

The package allows you to output the Stoplight UI by configuring only the paths to your openapi3 configs

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

Laravel Serve Stoplight	Laravel	PHP	Stoplight
^0.1.0	^8.0 \|\| ^9.0	^8.0	7.7.2
^0.1.5	^8.0 \|\| ^9.0 \|\| ^10.0	^8.0	7.7.2
^0.1.7	^8.0 \|\| ^9.0 \|\| ^10.0 \|\| ^11.0	^8.0	7.7.2
^0.2.0	^9.0 \|\| ^10.0 \|\| ^11.0	^8.1	8.1.3
^0.2.4	^9.0 \|\| ^10.0 \|\| ^11.0 \|\| ^12.0	^8.1	8.1.3

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

Please see CONTRIBUTING for details.

For update stoplight:

update stoplight-resources/web-components.min.js from https://unpkg.com/@stoplight/elements/web-components.min.js
update stoplight-resources/styles.min.css from https://unpkg.com/@stoplight/elements/styles.min.css
update current Stoplight version on Version Compatibility

Please review our security policy on how to report security vulnerabilities.

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