giahojnost/lumen-swagger

Lumen的OpenApi或Swagger集成，基于DarkaOnLine/SwaggerLume重构

维护者

详细信息

github.com/giahojnost/LumenSwagger

源代码

问题

安装: 22

依赖: 0

建议者: 0

安全: 0

星级: 0

关注者: 1

分支: 0

开放问题: 0

10.0.2 2023-04-07 07:42 UTC

Requires

Requires (Dev)

MIT 6b4fa9b25ed5ed3a5c61aaee675f126200a3cfef

  • Nick Jung <giahojnost.woop@gmail.com>

documentationuiapilaravelspecificationswaggeropenapilumen

This package is auto-updated.

Last update: 2024-09-07 10:52:12 UTC

README

Total Downloads

LumenSwagger

Lumen的Swagger 2.0-3.0

本包是Swagger-php（https://github.com/zircote/swagger-php）和swagger-ui（https://github.com/swagger-api/swagger-ui）的包装，适用于Lumen。

基于DarkaOnLine/LumenSwagger（https://github.com/DarkaOnLine/LumenSwagger）重构

  • 打开您的 bootstrap/app.php 文件，并在

创建应用程序 部分附近（大约第26行）取消注释此行

     $app->withFacades();

在 注册容器绑定 部分之前添加此行

     $app->configure('lumen-swagger');

在 注册服务提供者 部分添加此行

    $app->register(\LumenSwagger\ServiceProvider::class);
  • 运行 php artisan lumen-swagger:publish-config 以发布配置（config/lumen-swagger.php）
  • 根据需要更改配置
  • 运行 php artisan lumen-swagger:publish 以发布所有内容

使用 OpenApi 3.0 规范

如果您想在项目中使用最新的OpenApi规范（最初称为Swagger规范），您应该

  • 在您的项目的composer中显式要求 swagger-php 版本 3.*，通过运行
composer require 'zircote/swagger-php:4.*'
  • 在您的 .env 文件中将环境变量 SWAGGER_VERSION 设置为 3.0
SWAGGER_VERSION=3.0

或在您的 config/l5-swagger.php

'swagger_version' => env('SWAGGER_VERSION', '3.0'),

配置

  • 运行 php artisan lumen-swagger:publish-config 以发布配置（config/lumen-swagger.php）
  • 运行 php artisan lumen-swagger:publish-views 以发布视图（resources/views/vendor/lumen-swagger）
  • 运行 php artisan lumen-swagger:publish 以发布所有内容
  • 运行 php artisan lumen-swagger:generate 以生成文档

Swagger-php

实际的Swagger规范超出了本包的范围。LumenSwagger所做的只是将swagger-php和swagger-ui打包成Laravel友好的方式，并试图使其易于提供。有关如何使用swagger-php的信息，请查看这里。有关swagger-php的示例，请查看这里。