Skip to content

Commit

Permalink
Configure L5-Swagger
Browse files Browse the repository at this point in the history
  • Loading branch information
@jpcaparas
jpcaparas committed Apr 6, 2017
1 parent f6799cb commit 0d60221
Show file tree
Hide file tree
Showing 56 changed files with 8,313 additions and 0 deletions.
43 changes: 43 additions & 0 deletions app/Http/Controllers/Api/Controller.php
View file
@@ -0,0 +1,43 @@
<?php

namespace App\Http\Controllers\Api;

use App\Http\Controllers\Controller as BaseController;

/**
* @SWG\Swagger(
* host="swagger.test.jpcaparas.com",
* basePath="/api",
* schemes={"https"},
* produces={"application/json"},
* consumes={"application/json"},
* @SWG\Info(
* title="Laravel Swagger Demo",
* version="1.0",
* description="Swagger creates human-readable documentation for your APIs",
* @SWG\Contact(name="jp@jpcaparas.com"),
* @SWG\License(name="Unlicense")
* ),
* @SWG\Definition(
* definition="Timestamps",
* @SWG\Property(
* property="created_at",
* type="string",
* format="date-time",
* description="Creation date",
* example="2017-03-01 00:00:00"
* ),
* @SWG\Property(
* property="updated_at",
* type="string",
* format="date-time",
* description="Last updated",
* example="2017-03-01 00:00:00"
* )
* )
* )
*/
class Controller extends BaseController
{
//
}
Empty file modified artisan 100644 → 100755
View file
Empty file.
4 changes: 4 additions & 0 deletions config/app.php
View file
Expand Up @@ -177,6 +177,10 @@
App\Providers\EventServiceProvider::class,
App\Providers\RouteServiceProvider::class,

/*
* Swagger
*/
\L5Swagger\L5SwaggerServiceProvider::class,
],

/*
Expand Down
246 changes: 246 additions & 0 deletions config/l5-swagger.php
View file
@@ -0,0 +1,246 @@
<?php

return [

'api' => [

/*
|--------------------------------------------------------------------------
| Edit to set the api's title
|--------------------------------------------------------------------------
*/

'title' => 'Swagger UI',

/*
|--------------------------------------------------------------------------
| Edit to set the api's Auth token
|--------------------------------------------------------------------------
*/

'auth_token' => env('L5_SWAGGER_API_AUTH_TOKEN', false),

/*
|--------------------------------------------------------------------------
| Edit to set the api key variable in interface
|--------------------------------------------------------------------------
*/

'key_var' => env('L5_SWAGGER_API_KEY_VAR', 'api_key'),

/*
|--------------------------------------------------------------------------
| Edit to set the securityDefinition that is used in requests
|--------------------------------------------------------------------------
*/

'security_definition' => env('L5_SWAGGER_API_SECURITY_DEFINITION', 'api_key'),

/*
|--------------------------------------------------------------------------
| Edit to set where to inject api key (header, query)
|--------------------------------------------------------------------------
*/

'key_inject' => env('L5_SWAGGER_API_KEY_INJECT', 'query'),

/*
|--------------------------------------------------------------------------
| Edit to set the api's version number
|--------------------------------------------------------------------------
*/

'version' => env('L5_SWAGGER_API_VERSION', '1'),

/*
|--------------------------------------------------------------------------
| Edit to set the swagger version number
|--------------------------------------------------------------------------
*/

'swagger_version' => env('L5_SWAGGER_DEFAULT_API_VERSION', '1'),

],

'routes' => [

/*
|--------------------------------------------------------------------------
| Route for accessing api documentation interface
|--------------------------------------------------------------------------
*/

'api' => 'api/documentation',

/*
|--------------------------------------------------------------------------
| Route for accessing parsed swagger annotations.
|--------------------------------------------------------------------------
*/

'docs' => 'docs',

/*
|--------------------------------------------------------------------------
| Middleware allows to prevent unexpected access to API documentation
|--------------------------------------------------------------------------
*/
'middleware' => [
'api' => ['web'],
'docs' => [],
],

],

'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' => 'api-docs.json',

/*
|--------------------------------------------------------------------------
| Absolute path to directory containing the swagger annotations are stored.
|--------------------------------------------------------------------------
*/

'annotations' => base_path('app'),

/*
|--------------------------------------------------------------------------
| Absolute path to directory where to export assets
|--------------------------------------------------------------------------
*/

'assets' => public_path('vendor/l5-swagger'),

/*
|--------------------------------------------------------------------------
| Path to assets public directory
|--------------------------------------------------------------------------
*/

'assets_public' => '/vendor/l5-swagger',

/*
|--------------------------------------------------------------------------
| Absolute path to directory where to export views
|--------------------------------------------------------------------------
*/

'views' => base_path('resources/views/vendor/l5-swagger'),

/*
|--------------------------------------------------------------------------
| Edit to set the api's base path
|--------------------------------------------------------------------------
*/

'base' => env('L5_SWAGGER_BASE_PATH', null),

/*
|--------------------------------------------------------------------------
| Absolute path to directories that you would like to exclude from swagger generation
|--------------------------------------------------------------------------
*/

'excludes' => [],

],

/*
|--------------------------------------------------------------------------
| Turn this off to remove swagger generation on production
|--------------------------------------------------------------------------
*/

'generate_always' => env('L5_SWAGGER_GENERATE_ALWAYS', false),

/*
|--------------------------------------------------------------------------
| Edit to set the swagger version number
|--------------------------------------------------------------------------
*/

'swagger_version' => env('SWAGGER_VERSION', '2.0'),

/*
|--------------------------------------------------------------------------
| Edit to trust the proxy's ip address - needed for AWS Load Balancer
|--------------------------------------------------------------------------
*/

'proxy' => false,

/*
|--------------------------------------------------------------------------
| Edit to change layout of GUI ( 'none', 'list' or 'full')
|--------------------------------------------------------------------------
*/

'docExpansion' => env('L5_SWAGGER_DOC_EXPANSION', 'none'),

/*
|--------------------------------------------------------------------------
| Edit to change the maximum number of characters to highlight code.
|--------------------------------------------------------------------------
*/
'highlightThreshold' => env('L5_SWAGGER_HIGHLIGHT_THRESHOLD', 5000),

/*
|--------------------------------------------------------------------------
| Uncomment to pass the validatorUrl parameter to SwaggerUi init on the JS
| side. A null value here disables validation. A string will override
| the default url. If not specified, behavior is default and validation
| is enabled.
|--------------------------------------------------------------------------
*/

//'validatorUrl' => null,

'headers' => [

/*
|--------------------------------------------------------------------------
| Uncomment to add response headers when swagger is generated
|--------------------------------------------------------------------------
*/

//'view' => [
// 'Content-Type' => 'text/plain',
//],

/*
|--------------------------------------------------------------------------
| Uncomment to add request headers when swagger performs requests
|--------------------------------------------------------------------------
*/

//'request' => [
// 'TestMe' => 'testValue',
//],

],

/*
|--------------------------------------------------------------------------
| Uncomment to add constants which can be used in anotations
|--------------------------------------------------------------------------
*/
'constants' => [
//'L5_SWAGGER_CONST_HOST' => env('L5_SWAGGER_CONST_HOST', 'http://my-default-host.com'),
],

];

0 comments on commit 0d60221

Please sign in to comment.