[![Total Downloads](https://poser.pugx.org/DarkaOnLine/L5-Swagger/downloads.svg)](https://packagist.org/packages/DarkaOnLine/L5-Swagger) ![Build Status](https://github.com/DarkaOnLine/L5-Swagger/actions/workflows/test-config.yml/badge.svg?branch=master) [![Coverage Status](https://coveralls.io/repos/github/DarkaOnLine/L5-Swagger/badge.svg?branch=master)](https://coveralls.io/github/DarkaOnLine/L5-Swagger?branch=master) [![Maintainability](https://qlty.sh/gh/DarkaOnLine/projects/L5-Swagger/maintainability.svg)](https://qlty.sh/gh/DarkaOnLine/projects/L5-Swagger) [![StyleCI](https://styleci.io/repos/32315619/shield?style=flat&branch=master)](https://styleci.io/repos/32315619) [![GuitHub Sponsor](https://img.shields.io/static/v1?label=Sponsor%20L5-Swagger&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/DarkaOnLine) L5 Swagger - OpenApi or Swagger Specification for your Laravel project made easy. ========== ## Please visit [L5 Swagger Wiki](https://github.com/DarkaOnLine/L5-Swagger/wiki) for more information: - [Getting Started](https://github.com/DarkaOnLine/L5-Swagger/wiki/Getting-Started) - [Configuration](https://github.com/DarkaOnLine/L5-Swagger/wiki/Configuration) - [Examples](https://github.com/DarkaOnLine/L5-Swagger/wiki/Examples) - [Tips](https://github.com/DarkaOnLine/L5-Swagger/wiki/Tips) - [Using Swagger UI with Passport](https://github.com/DarkaOnLine/L5-Swagger/wiki/Using-Swagger-UI-with-Passport) - [Related Projects](https://github.com/DarkaOnLine/L5-Swagger/wiki/Related-Projects) - [Migration Guides](https://github.com/DarkaOnLine/L5-Swagger/wiki/Migration-Guides) - [Change Log](https://github.com/DarkaOnLine/L5-Swagger/releases) ## Support [![GuitHub Sponsor](https://img.shields.io/static/v1?label=Sponsor%20L5-Swagger&message=%E2%9D%A4&logo=GitHub)](https://github.com/sponsors/DarkaOnLine) ### Disclaimer This 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 Laravel. The actual Swagger spec is beyond the scope of this package. All L5-Swagger 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](https://zircote.github.io/swagger-php/). For good examples of swagger-php in action [look here](https://github.com/zircote/swagger-php/tree/master/docs/examples/specs/petstore).