pharmit/swaggervel

A great way to integrate Swagger into Laravel

dev-master 2017-05-29 11:54 UTC

Requires

• php: >=5.3.0
• zircote/swagger-php: *

MIT

• jlapp

• documentation
• api
• laravel
• L4
• swagger
• l5

README

This fork uses Swagger-spec 2.0 and Swagger-php 2.0. This fork also updates the Swagger-ui to version 2.1.1.

To use this package, add to the composer.json:

"repositories": [
        {
          "type": "vcs",
          "url": "https://github.com/tralves/Swaggervel"
        }
    ],
(...)
"require": {
  "jlapp/swaggervel": "master-dev",
}

OAuth2

The Swagger-ui was changed to allow inserting the OAuth 2 parameters (client_id, client_secret, realm and appName) directly in the ui. You can also pass these values in the url in the URL, like so: http://api.appcursos.com/api-docs?client_id=my-client-id&client_secret=my-client-secret&realm=my-realm&appName=my-app-name

The rest of this document comes from the original (and awesome) package Swaggervel

To use Swaggervel for Laravel 4.2, use the version 1.0 branch (https://github.com/slampenny/Swaggervel/tree/1.0)

Swaggervel

Swagger for Laravel

This package combines Swagger-php and swagger-ui into one Laravel-friendly package.

When you run your app in debug mode, Swaggervel will scan your app folder (or any folder that is set under the "app-dir" variable in the packages config), generate swagger json files and deposit them to the doc-dir folder (default is /docs). Files are then served by swagger-ui under the api-docs director.

Installation

• Require "pharmit/swaggervel": "dev-master" in your composer.json.
• Add PharmIT\Swaggervel\SwaggervelServiceProvider to your providers array in app/config/app.php above your route provider, to avoid any catch-all routes.
• Run php artisan vendor:publish to push swagger-ui to your public folder.
• Add CREDENTIALS_USERNAME=YOUR_USERNAME and CREDENTIALS_PASSWORD=YOUR_PASSWORD to your .env file.

Example

• www.example.com/docs <- swagger JSON files are visible
• www.example.com/api-docs <- swagger ui is visible.

Options

Uncomment the "viewHeaders" option in the Config file to add headers to your view.

How to Use Swagger-php

The actual Swagger spec is beyond the scope of this package. All Swaggervel 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. For good examples of swagger-php in action look here.

For Laravel 5, please use the 2.0 branch!

For Laravel 4, please use the 1.0 branch!

Swaggervel

Swagger for Laravel

This package combines Swagger-php and swagger-ui into one Laravel-friendly package.

When you run your app in debug mode, Swaggervel will scan your app folder (or any folder that is set under the "app-dir" variable in the packages config), generate swagger json files and deposit them to the doc-dir folder (default is /docs). Files are then served by swagger-ui under the api-docs director.

Installation

• Add Jlapp\Swaggervel\SwaggervelServiceProvider to your providers array in app/config/app.php above your routes provider (to avoid catch all routes)
• Run php artisan vendor:publish to push config files to your app folder.

Example

• www.example.com/docs <- swagger JSON files are visible
• www.example.com/api-docs <- swagger ui is visible.

Options

Uncomment the "viewHeaders" option in the Config file to add headers to your view.

How to Use Swagger-php

The actual Swagger spec is beyond the scope of this package. All Swaggervel 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. For good examples of swagger-php in action look here.