seldatdirect/swagger-lume

Swagger集成到Lumen 5

1.0.1 2016-05-24 09:51 UTC

This package is not auto-updated.

Last update: 2024-09-23 15:13:22 UTC


README

Build Status Test Coverage Code Climate StyleCI Total Downloads

SwaggerLume

Swagger 2.0 for Lumen 5

此包是Swagger-phpswagger-ui的包装器,用于与Lumen 5一起使用。

原始源代码

https://github.com/DarkaOnLine/SwaggerLume

安装

    composer require "seldatdirect/swagger-lume 1.*"
  • 打开您的bootstrap/app.php文件,并在创建应用程序部分

取消注释第26行附近的这一行

     $app->withFacades();

注册容器绑定部分之前添加这一行

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

注册服务提供者部分添加这一行

    $app->register(\SwaggerLume\ServiceProvider::class);
  • 运行php artisan swagger-lume:publish-config以发布配置(config/swagger-lume.php
  • 如有需要,请进行配置更改
  • 运行swagger-lume:publish以发布所有内容

配置

  • 运行swagger-lume:publish-config以发布配置(config/swagger-lume.php
  • 运行swagger-lume:publish-assets以将swagger-ui发布到您的公共文件夹(public/vendor/swagger-lume
  • 运行swagger-lume:publish-views以发布视图(resources/views/vendor/swagger-lume
  • 运行swagger-lume:publish以发布所有内容
  • 运行swagger-lume:generate以生成文档

Swagger-php

实际的Swagger规范超出了本包的范围。SwaggerLume所做的只是以Laravel友好的方式打包swagger-php和swagger-ui,并尝试使其易于服务。有关如何使用swagger-php的信息,请查看这里。有关swagger-php在实际中的良好示例,请查看这里