|
|
|
<?php
|
|
|
|
|
|
|
|
return [
|
|
|
|
/*
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
| API Title
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
| The title of your API documentation.
|
|
|
|
|
|
|
|
|
*/
|
|
|
|
"title" => env("SWAGGER_TITLE", "Globalso V6 Api Documentation"),
|
|
|
|
|
|
|
|
/*
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
| API Description
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
| The description of your API.
|
|
|
|
|
|
|
|
|
*/
|
|
|
|
"description" => env("SWAGGER_DESCRIPTION", "Laravel autogenerate swagger"),
|
|
|
|
|
|
|
|
/*
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
| API Email
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
| The email associated with your API documentation.
|
|
|
|
|
|
|
|
|
*/
|
|
|
|
"email" => env("SWAGGER_EMAIL", "bill@ai.cc"),
|
|
|
|
|
|
|
|
/*
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
| API Version
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
| The version of your API.
|
|
|
|
|
|
|
|
|
*/
|
|
|
|
"version" => env("SWAGGER_VERSION", "3.0.7"),
|
|
|
|
|
|
|
|
/*
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
| Documentation Auth
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
| This options to enable documentation auth
|
|
|
|
|
|
|
|
|
*/
|
|
|
|
"enable_auth" => false,
|
|
|
|
"username" => "admin",
|
|
|
|
"password" => "pass",
|
|
|
|
"sesson_ttl" => 100000,
|
|
|
|
|
|
|
|
/*
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
| Enable Response Schema
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
| Whether to enable response schema or not.
|
|
|
|
|
|
|
|
|
*/
|
|
|
|
"enable_response_schema" => true,
|
|
|
|
|
|
|
|
"suggestions_select_input" => false,
|
|
|
|
|
|
|
|
"load_from_json" => false,
|
|
|
|
|
|
|
|
/*
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
| Authentication Middlewares
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
| List of middleware names used for authentication.
|
|
|
|
|
|
|
|
|
*/
|
|
|
|
"auth_middlewares" => [
|
|
|
|
"auth",
|
|
|
|
"auth:api",
|
|
|
|
"aloginauth",
|
|
|
|
"bloginauth",
|
|
|
|
],
|
|
|
|
|
|
|
|
/*
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
| API URL
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
| The URL path for accessing your API documentation.
|
|
|
|
|
|
|
|
|
*/
|
|
|
|
"url" => env("SWAGGER_URL", "swagger/documentation"),
|
|
|
|
|
|
|
|
/*
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
| Issues URL
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
| The URL path for accessing issues related to your API documentation.
|
|
|
|
|
|
|
|
|
*/
|
|
|
|
"issues_url" => env("SWAGGER_ISSUE_URL", "swagger/issues"),
|
|
|
|
|
|
|
|
/*
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
| Enable Swagger
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
| Whether Swagger is enabled or not.
|
|
|
|
|
|
|
|
|
*/
|
|
|
|
"enable" => env('SWAGGER_ENABLED', true),
|
|
|
|
|
|
|
|
/*
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
| Show Prefix
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
| List of prefixes to show in Swagger.
|
|
|
|
|
|
|
|
|
*/
|
|
|
|
"show_prefix" => [],
|
|
|
|
|
|
|
|
/*
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
| Include Web Routes
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
| If you want to includes web.php routes, then enable this
|
|
|
|
|
|
|
|
|
*/
|
|
|
|
"include_web_routes" => env('SWAGGER_INCLUDE_WEB_ROUTES', true),
|
|
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
| API Versions
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
| List of versions to show in Swagger.
|
|
|
|
|
|
|
|
|
*/
|
|
|
|
"versions" => [
|
|
|
|
"all",
|
|
|
|
// "v1"
|
|
|
|
],
|
|
|
|
|
|
|
|
"default" => "all",
|
|
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
| Servers
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
| List of servers associated with your API.
|
|
|
|
|
|
|
|
|
*/
|
|
|
|
"servers" => [
|
|
|
|
[
|
|
|
|
"url" => env("APP_URL"),
|
|
|
|
"description" => "localhost"
|
|
|
|
]
|
|
|
|
],
|
|
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
| Security Schemes
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
| Security schemes used in your API.
|
|
|
|
|
|
|
|
|
*/
|
|
|
|
"security_schemes" => [
|
|
|
|
"APIKeyHeader" => [
|
|
|
|
"type" => "apiKey",
|
|
|
|
"name" => "token",
|
|
|
|
"in" => "header"
|
|
|
|
],
|
|
|
|
],
|
|
|
|
|
|
|
|
/*
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
| Spatie Query Builder
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
| Enable it if you using Spatie query builder package to add spatie filters in all GET routes.
|
|
|
|
|
|
|
|
|
*/
|
|
|
|
"spatie_query_builder" => false,
|
|
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
| Status
|
|
|
|
|--------------------------------------------------------------------------
|
|
|
|
|
|
|
|
|
| HTTP response statuses for various methods.
|
|
|
|
|
|
|
|
|
*/
|
|
|
|
"status" => [
|
|
|
|
"GET" => [
|
|
|
|
"200" => [
|
|
|
|
"description" => "Successful Operation",
|
|
|
|
],
|
|
|
|
"404" => [
|
|
|
|
"description" => "Not Found"
|
|
|
|
]
|
|
|
|
],
|
|
|
|
"POST" => [
|
|
|
|
"200" => [
|
|
|
|
"description" => "Successful Operation",
|
|
|
|
],
|
|
|
|
"422" => [
|
|
|
|
"description" => "Validation Issues"
|
|
|
|
]
|
|
|
|
],
|
|
|
|
"PUT" => [
|
|
|
|
"200" => [
|
|
|
|
"description" => "Successful Operation",
|
|
|
|
],
|
|
|
|
"404" => [
|
|
|
|
"description" => "Not Found"
|
|
|
|
],
|
|
|
|
"405" => [
|
|
|
|
"description" => "Validation exception"
|
|
|
|
]
|
|
|
|
],
|
|
|
|
"PATCH" => [
|
|
|
|
"200" => [
|
|
|
|
"description" => "Successful Operation",
|
|
|
|
],
|
|
|
|
"404" => [
|
|
|
|
"description" => "Not Found"
|
|
|
|
],
|
|
|
|
"405" => [
|
|
|
|
"description" => "Validation exception"
|
|
|
|
]
|
|
|
|
],
|
|
|
|
"DELETE" => [
|
|
|
|
"200" => [
|
|
|
|
"description" => "successful Operation",
|
|
|
|
],
|
|
|
|
"404" => [
|
|
|
|
"description" => "page Not Found"
|
|
|
|
]
|
|
|
|
],
|
|
|
|
],
|
|
|
|
|
|
|
|
]; |
...
|
...
|
|