imikemiller/l5-swagger-redoc

Swagger integration to Laravel 5 using the Rebilly Redoc UI.

Sunday, January 7, 2018
by imikemiller
Repository
0 Watchers
0 Stars
35 Installations

PHP
0 Dependents
0 Suggesters
89 Forks
0 Open issues
32 Versions
9 % Grown

The README.md

This is a fork of DarkaOnLine/L5-Swagger which is based on swagger-PHP and swagger-UI., _(*1)

Instead of the stock Swagger interface this package uses the Rebilly/Redoc UI., _(*2)

Installation & Usage

composer require imikemiller/l5-swagger-redoc

Register the service provider L5Swagger\L5SwaggerServiceProvider::class in the Laravel app config file config/app.php and run, _(*3)

php artisan l5-swagger:publish //to publish the resources
php artisan l5-swagger:generate //to generate the doc spec json

By default the documentation will be available at http://{base_url}/api/documentation. You can configure the page title and other Swagger configuration options by editing config/l5-swagger.php., _(*4)

TODO

Add support for configuration of the Redoc UI

Example Controller Annotations

```php <?php /** * @SWG\Swagger( * basePath="/api/v1", * schemes={"http", "https"}, * host=L5_SWAGGER_CONST_HOST, * @SWG\Info( * version="1.0.0", * title="L5 Swagger API", * description="L5 Swagger API description", * @SWG\Contact( * email="darius@matulionis.lt" * ), * ) * ) */ /** * @SWG\Get( * path="/projects", * operationId="getProjectsList", * tags={"Projects"}, * summary="Get list of projects", * description="Returns list of projects", * @SWG\Response( * response=200, * description="successful operation" * ), * @SWG\Response(response=400, description="Bad request"), * security={ * {"api_key_security_example": {}} * } * ) * * Returns list of projects */ /** * @SWG\Get( * path="/projects/{id}", * operationId="getProjectById", * tags={"Projects"}, * summary="Get project information", * description="Returns project data", * @SWG\Parameter( * name="id", * description="Project id", * required=true, * type="integer", * in="path" * ), * @SWG\Response( * response=200, * description="successful operation" * ), * @SWG\Response(response=400, description="Bad request"), * @SWG\Response(response=404, description="Resource Not Found"), * security={ * { * "oauth2_security_example": {"write:projects", "read:projects"} * } * }, * ) * */, _(*5)

```, _(*6)

The Versions

07/01 2018

dev-lumen-support

Swagger integration to Laravel 5 using the Rebilly Redoc UI.

library l5-swagger-redoc

Swagger integration to Laravel 5 using the Rebilly Redoc UI.

imikemiller/l5-swagger-redoc

The README.md

Installation & Usage

TODO

Example Controller Annotations

The Versions

dev-lumen-support

The Requires

The Development Requires

by Darius Matulionis

by Mike Miller

v2.5

The Requires

The Development Requires

by Darius Matulionis

by Mike Miller

dev-master

The Requires

The Development Requires

by Darius Matulionis

by Mike Miller

5.0.3

The Requires

The Development Requires

by Darius Matulionis

5.0.2

The Requires

The Development Requires

by Darius Matulionis

5.0.1

The Requires

The Development Requires

by Darius Matulionis

5.0

The Requires

The Development Requires

by Darius Matulionis

3.2.3

The Requires

The Development Requires

by Darius Matulionis

3.x-dev

The Requires

The Development Requires

by Darius Matulionis

3.2.2

The Requires

The Development Requires

by Darius Matulionis

4.0.1

The Requires

The Development Requires

by Darius Matulionis

4.0.x-dev

The Requires

The Development Requires

by Darius Matulionis

4.0

The Requires

The Development Requires

by Darius Matulionis

3.2.1

The Requires

The Development Requires

by Darius Matulionis

3.2

The Requires

The Development Requires

by Darius Matulionis

3.1.5

The Requires

The Development Requires

by Darius Matulionis

3.1.4

The Requires

The Development Requires

by Darius Matulionis

3.1.3