haribabu500/darkonline-l5-swagger

multiple ui generation for mobile and web api using swagger darkonline plugin

darkonline-L5-Swagger

multiple ui generation in swager

This doucment is for the user of darkonlin/l5-swagger for multiple ui generation

Installation

composer require "darkaonline/l5-swagger:5.6.*"

To get started, first publish L5-Swagger's config and view files into your own project:

php artisan vendor:publish --provider "L5Swagger\L5SwaggerServiceProvider"

publish config if not available

php artisan l5-swagger:publish-config

Mobile and web documentation seperation in config/l5-swagger.php

for web added default as it is and for mobile added mobile

     'api' => [
            /*
            |--------------------------------------------------------------------------
            | Edit to set the this group's title, will override global title
            |--------------------------------------------------------------------------
            */
           'separated_doc' => true
            ],
    'default' => [
        'api' => [
            /*
            |--------------------------------------------------------------------------
            | Edit to set the this group's title, will override global title
            |--------------------------------------------------------------------------
            */
            'title' => 'Laravel Web API Documentation UI',
        ],
        'routes' => [
            /*
            |--------------------------------------------------------------------------
            | Route for accessing this group api documentation interface
            |--------------------------------------------------------------------------
            */
            'api' => 'api/documentation',
        ],
        'paths' => [
            /*
            |--------------------------------------------------------------------------
            | Absolute path to location where parsed swagger annotations will be stored
            |--------------------------------------------------------------------------
            */
            'docs' => storage_path('api-docs'),
            /*
            |--------------------------------------------------------------------------
            | File name of the generated json documentation file
            |--------------------------------------------------------------------------
            */
            'docs_json' => 'default-api-docs.json',
            /*
            |--------------------------------------------------------------------------
            | Absolute path to directory containing the swagger annotations are stored.
            |--------------------------------------------------------------------------
            */
            'annotations' => base_path('app/'),
        ],
    ],
    'mobile' => [
        'api' => [
            /*
            |--------------------------------------------------------------------------
            | Edit to set the this group's title, will override global title
            |--------------------------------------------------------------------------
            */
            'title' => 'Laravel Mobile API Documentation UI',
        ],
        'routes' => [
            /*
            |--------------------------------------------------------------------------
            | Route for accessing this group api documentation interface
            |--------------------------------------------------------------------------
            */
            'api' => 'mobapi/documentation',
        ],
        'paths' => [
            /*
            |--------------------------------------------------------------------------
            | Absolute path to location where parsed swagger annotations will be stored
            |--------------------------------------------------------------------------
            */
            'docs' => storage_path('api-docs'),
            /*
            |--------------------------------------------------------------------------
            | File name of the generated json documentation file
            |--------------------------------------------------------------------------
            */
            'docs_json' => 'mobile-api-docs.json',
            /*
            |--------------------------------------------------------------------------
            | Absolute path to directory containing the swagger annotations are stored.
            |--------------------------------------------------------------------------
            */
            'annotations' => base_path('app/'),
        ],
    ],

copy the vendor/darkonline

Generate the doucmentation

php artisan l5-swagger:generate

Changed the generated json file in storage/api-docs folder as required

URL

localhost/api/documentation localhost/mobapi/documenation

References

DarkaOnLine/L5-Swagger#149 https://github.com/DarkaOnLine/L5-Swagger/compare/master...rswork:5.4.x-multidoc

Future Help Required

-- change in the plugin without editing vendor files

-- seperate base url Without editingjson file.