juststeveking/laravel-stoplight-elements

一个简单的Laravel API文档包，使用OpenAPI和Stoplight Elements

维护者

详细信息

github.com/JustSteveKing/laravel-stoplight-elements

源代码

问题

资助包维护！
JustSteveKing

安装数: 41,293

依赖项: 0

建议者: 0

安全: 0

星标: 36

关注者: 3

分支: 6

公开问题: 1

3.0.0 2024-03-13 09:47 UTC

Requires

Requires (Dev)

MIT d4a0761db603be7a693c2b99795a57695f064a32

documentationapilaravelopenapistoplightstoplight elements

This package is auto-updated.

Last update: 2024-09-13 10:45:39 UTC

README

Latest Version on Packagist Software License Build Status Total Downloads

轻松使用您的Laravel应用程序中的OpenAPI文档发布API文档。

安装

您可以通过composer安装此包

composer require juststeveking/laravel-stoplight-elements

配置

您可以使用以下命令发布配置文件

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

这是已发布配置文件的内容

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和CODE_OF_CONDUCT获取详细信息。

安全

如果您发现任何与安全相关的问题，请通过电子邮件juststevemcd@gmail.com联系，而不是使用问题跟踪器。

鸣谢

许可证

MIT许可证（MIT）。请参阅许可证文件获取更多信息。