ensi/laravel-serve-stoplight

Laravel serve stoplight

0.2.0 2024-06-26 12:50 UTC

This package is auto-updated.

Last update: 2024-08-27 08:49:30 UTC


README

Latest Version on Packagist Tests Total Downloads

此包允许您通过仅配置openapi3配置文件的路径来输出Stoplight UI

基于 stoplight/elements

安装

您可以通过composer安装此包

composer require ensi/laravel-serve-stoplight

发布配置文件如下

php artisan vendor:publish --provider="Ensi\LaravelServeStoplight\ServeStoplightServiceProvider"

配置 config/serve-stoplight.php

版本兼容性

基本用法

默认情况下,v1 规范位于 docs/oas (与 docs/oas/v1 的完整路径相同)。

如果您需要打开另一个版本的规范,请使用 docs/os/{version} 路径,例如,docs/os/v2

贡献

有关详细信息,请参阅 CONTRIBUTING

更新stoplight

关于更新stoplight

  1. https://unpkg.com/@stoplight/elements/web-components.min.js 更新 stoplight-resources/web-components.min.js
  2. https://unpkg.com/@stoplight/elements/styles.min.css 更新 stoplight-resources/styles.min.css
  3. 版本兼容性 上更新当前Stoplight版本

测试

  1. composer install
  2. composer test

安全漏洞

请查阅我们如何报告安全漏洞的 安全策略

许可证

MIT 许可证 (MIT)。更多信息请参阅 许可证文件