{"id":15627925,"url":"https://github.com/darkaonline/swaggerlume","last_synced_at":"2025-05-15T14:05:29.228Z","repository":{"id":3545247,"uuid":"50113229","full_name":"DarkaOnLine/SwaggerLume","owner":"DarkaOnLine","description":"Lumen swagger","archived":false,"fork":false,"pushed_at":"2024-05-15T06:18:08.000Z","size":2147,"stargazers_count":336,"open_issues_count":7,"forks_count":84,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-05-15T14:05:23.272Z","etag":null,"topics":["lumen","lumen-package","swagger","swagger-php","swagger-ui"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/DarkaOnLine.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["DarkaOnLine"]}},"created_at":"2016-01-21T14:33:06.000Z","updated_at":"2025-05-04T14:10:42.000Z","dependencies_parsed_at":"2024-06-18T12:37:30.730Z","dependency_job_id":null,"html_url":"https://github.com/DarkaOnLine/SwaggerLume","commit_stats":{"total_commits":87,"total_committers":16,"mean_commits":5.4375,"dds":"0.28735632183908044","last_synced_commit":"7a12e15b50ee90278009e690cf3d493c29b8794e"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DarkaOnLine%2FSwaggerLume","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DarkaOnLine%2FSwaggerLume/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DarkaOnLine%2FSwaggerLume/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/DarkaOnLine%2FSwaggerLume/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/DarkaOnLine","download_url":"https://codeload.github.com/DarkaOnLine/SwaggerLume/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254355334,"owners_count":22057354,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["lumen","lumen-package","swagger","swagger-php","swagger-ui"],"created_at":"2024-10-03T10:19:59.212Z","updated_at":"2025-05-15T14:05:24.213Z","avatar_url":"https://github.com/DarkaOnLine.png","language":"PHP","funding_links":["https://github.com/sponsors/DarkaOnLine"],"categories":[],"sub_categories":[],"readme":"[![Total Downloads](https://poser.pugx.org/DarkaOnLine/swagger-lume/downloads.svg)](https://packagist.org/packages/DarkaOnLine/swagger-lume)\n![Build Status](https://github.com/DarkaOnLine/SwaggerLume/actions/workflows/test-config.yml/badge.svg?branch=master)\n[![Coverage Status](https://coveralls.io/repos/github/DarkaOnLine/SwaggerLume/badge.svg?branch=master)](https://coveralls.io/github/DarkaOnLine/SwaggerLume?branch=master)\n[![Code Climate](https://codeclimate.com/github/DarkaOnLine/SwaggerLume/badges/gpa.svg)](https://codeclimate.com/github/DarkaOnLine/SwaggerLume)\n[![StyleCI](https://styleci.io/repos/50113229/shield)](https://styleci.io/repos/50113229)\n\nSwaggerLume\n==========\n\nSwagger 2.0-3.0 for Lumen\n\nThis package is a wrapper of [Swagger-php](https://github.com/zircote/swagger-php) and [swagger-ui](https://github.com/swagger-api/swagger-ui) adapted to work with Lumen.\n\nInstallation\n============\n\n Lumen      | Swagger UI| OpenAPI Spec compatibility | L5-Swagger\n:-----------|:----------|:---------------------------|:----------\n 5.0 - 5.3  | 2.2       | 1.1, 1.2, 2.0              | ``` composer require \"darkaonline/swagger-lume:~1.0\" ```\n 5.4.x      | 2.2       | 1.1, 1.2, 2.0              | ``` composer require \"darkaonline/swagger-lume:~2.0\" ```\n 5.4.x      | 3         | 2.0                        | ``` composer require \"darkaonline/swagger-lume:~3.0\" ```\n 5.5.x      | 3         | 2.0                        | ``` composer require \"darkaonline/swagger-lume:5.5.*\" ```\n 5.6 - 5.7  | 3         | 2.0, 3.0                   | ``` composer require \"darkaonline/swagger-lume:5.6.*\" ```\n 6.0        | 3         | 2.0, 3.0                   | ``` composer require \"darkaonline/swagger-lume:6.*\" ```\n 7.0        | 3         | 2.0, 3.0                   | ``` composer require \"darkaonline/swagger-lume:7.*\" ```\n 8.0        | 3         | 2.0, 3.0                   | ``` composer require \"darkaonline/swagger-lume:8.*\" ```\n 9.0        | 3         | 2.0, 3.0                   | ``` composer require \"darkaonline/swagger-lume:9.*\" ```\n 10.0       | 3         | 2.0, 3.0                   | ``` composer require \"darkaonline/swagger-lume:10.*\" ```\n\n- Open your `bootstrap/app.php` file and:\n\nuncomment this line (around line 26) in `Create The Application` section:\n```php\n     $app-\u003ewithFacades();\n```\n\nadd this line before `Register Container Bindings` section:\n```php\n     $app-\u003econfigure('swagger-lume');\n```\n\nadd this line in `Register Service Providers` section:\n```php\n    $app-\u003eregister(\\SwaggerLume\\ServiceProvider::class);\n```\n\n- Run `php artisan swagger-lume:publish-config` to publish configs (`config/swagger-lume.php`)\n- Make configuration changes if needed\n- Run `php artisan swagger-lume:publish` to publish everything\n\nUsing [OpenApi 3.0 Specification](https://github.com/OAI/OpenAPI-Specification)\n============\nIf you would like to use latest OpenApi specifications (originally known as the Swagger Specification) in your project you should:\n- Explicitly require `swagger-php` version 3.* in your projects composer by running:\n```bash\ncomposer require 'zircote/swagger-php:3.*'\n```\n- Set environment variable `SWAGGER_VERSION` to **3.0** in your `.env` file:\n```\nSWAGGER_VERSION=3.0\n```\nor in your `config/l5-swagger.php`:\n```php\n'swagger_version' =\u003e env('SWAGGER_VERSION', '3.0'),\n```\n- Use examples provided here: https://github.com/zircote/swagger-php/tree/3.x/Examples/petstore-3.0\n\nConfiguration\n============\n- Run `php artisan swagger-lume:publish-config` to publish configs (`config/swagger-lume.php`)\n- Run `php artisan swagger-lume:publish-views` to publish views (`resources/views/vendor/swagger-lume`)\n- Run `php artisan swagger-lume:publish` to publish everything\n- Run `php artisan swagger-lume:generate` to generate docs\n\nChanges in 3.0\n============\n- Swagger UI 3.\n- Configuration changes.\n- Assets dependency dropped. Now includes from composer package.\n- [See migration from 2.0 to 3.0](#migrate-from-20-to-30-or-55)\n\nChanges in 2.0\n============\n- Lumen 5.4 support\n- Swagger UI 2.2.8\n\nMigrate from 2.0 to 3.0 or 5.5\n============\n- Remove `config/swagger-lume.php` file (make a copy if needed)\n- Remove `public/vendor/swagger-lume` directory\n- Remove `resources/views/vendor/swagger-lume` directory\n- Run `swagger-lume:publish` to publish new swagger-ui view and configuration\n- Edit your `config/swagger-lume.php` file\n\nSwagger-php\n======================\nThe actual Swagger spec is beyond the scope of this package. All SwaggerLume does is package up swagger-php and swagger-ui in a Laravel-friendly fashion, and tries to make it easy to serve. For info on how to use swagger-php [look here](http://zircote.com/swagger-php/). For good examples of swagger-php in action [look here](https://github.com/zircote/swagger-php/tree/master/Examples/petstore.swagger.io).\n\n**Important:** Make sure that you add the include statement on all pages with annotations!\n\n```\nuse OpenApi\\Annotations as OA;\n```\n\n## Support on Beerpay\nHey dude! Help me out for a couple of :beers:!\n\n[![Beerpay](https://beerpay.io/DarkaOnLine/SwaggerLume/badge.svg?style=beer-square)](https://beerpay.io/DarkaOnLine/SwaggerLume)  [![Beerpay](https://beerpay.io/DarkaOnLine/SwaggerLume/make-wish.svg?style=flat-square)](https://beerpay.io/DarkaOnLine/SwaggerLume?focus=wish)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarkaonline%2Fswaggerlume","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdarkaonline%2Fswaggerlume","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarkaonline%2Fswaggerlume/lists"}