swagger.php
6.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
<?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"
]
],
],
];