PHPackages                             weburnit/swaggeravel - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. weburnit/swaggeravel

ActiveLibrary[API Development](/categories/api)

weburnit/swaggeravel
====================

This package allows you to: generate RESTful API document using Swagger PHP.

1.0(8y ago)027MITPHPPHP >=5.3.0

Since Jul 11Pushed 8y ago1 watchersCompare

[ Source](https://github.com/weburnit/swaggeravel)[ Packagist](https://packagist.org/packages/weburnit/swaggeravel)[ Docs](https://github.com/weburnit/swaggeravel)[ RSS](/packages/weburnit-swaggeravel/feed)WikiDiscussions master Synced 3d ago

READMEChangelogDependencies (7)Versions (4)Used By (0)

Swagger/LaraSwagger
===================

[](#swaggerlaraswagger)

[![Software License](https://camo.githubusercontent.com/55c0218c8f8009f06ad4ddae837ddd05301481fcf0dff8e0ed9dadda8780713e/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e73652d4d49542d627269676874677265656e2e7376673f7374796c653d666c61742d737175617265)](LICENSE.md)
===========================================================================================================================================================================================================================================================================================

[](#)

This package is a wrapper of [Swagger-php](https://github.com/zircote/swagger-php) and makes it easy to integrate with Lumen/Larvarel.

Usage
-----

[](#usage)

### Installation

[](#installation)

Via Composer

Add information about new package in your `composer.json`

```
    "repositories": [
        {
          "type": "vcs",
          "url": "git@gitlab.lzd.co:operations/laraswagger.git",
          "name": "lazada/database-minifier"
        }
    ],
    "require": {
        "lazada/laraswagger": ">=1.0.0"
    }
```

After the composer install finishes, register the service provider:

- Lumen Application:

```
$app->register(Swagger\LaraSwagger\Providers\LumeSwaggerServiceProvider::class);
```

- Laravel Application: not supports yet.

Now you can rock with LaraSwagger:

- Run `php artisan swagger:generate file_name [base_host]`: to generate swagger api docs.
- Go to `/swagger/api-docs` (default routing config) to see swagger api docs in JSON format

### Default configuration

[](#default-configuration)

```