forked from andreaselia/laravel-api-to-postman
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi-postman.php
131 lines (109 loc) · 3.5 KB
/
api-postman.php
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
<?php
return [
/*
|--------------------------------------------------------------------------
| Base URL
|--------------------------------------------------------------------------
|
| The base URL for all of your endpoints.
|
*/
'base_url' => env('APP_URL', 'http://localhost'),
/*
|--------------------------------------------------------------------------
| Collection Filename
|--------------------------------------------------------------------------
|
| The name for the collection file to be saved.
|
*/
'filename' => '{timestamp}_{app}_collection.json',
/*
|--------------------------------------------------------------------------
| Structured
|--------------------------------------------------------------------------
|
| If you want folders to be generated based on namespace.
|
*/
'structured' => false,
/*
|--------------------------------------------------------------------------
| Auth Middleware
|--------------------------------------------------------------------------
|
| The middleware which wraps your authenticated API routes.
|
| E.g. auth:api, auth:sanctum
|
*/
'auth_middleware' => 'auth:api',
/*
|--------------------------------------------------------------------------
| Headers
|--------------------------------------------------------------------------
|
| The headers applied to all routes within the collection.
|
*/
'headers' => [
[
'key' => 'Accept',
'value' => 'application/json',
],
[
'key' => 'Content-Type',
'value' => 'application/json',
],
],
/*
|--------------------------------------------------------------------------
| Enable Form Data
|--------------------------------------------------------------------------
|
| Determines whether or not form data should be handled.
|
*/
'enable_formdata' => false,
/*
|--------------------------------------------------------------------------
| Parse Form Request Rules
|--------------------------------------------------------------------------
|
| If you want form requests to be printed in the field description field,
| and if so, whether they will be in a human readable form.
|
*/
'print_rules' => true, // @requires: 'enable_formdata' === true
'rules_to_human_readable' => true, // @requires: 'parse_rules' === true
/*
|--------------------------------------------------------------------------
| Form Data
|--------------------------------------------------------------------------
|
| The key/values to requests for form data dummy information.
|
*/
'formdata' => [
// 'email' => 'john@example.com',
// 'password' => 'changeme',
],
/*
|--------------------------------------------------------------------------
| Include Middleware
|--------------------------------------------------------------------------
|
| The routes of the included middleware are included in the export.
|
*/
'include_middleware' => ['api'],
/*
|--------------------------------------------------------------------------
| Disk Driver
|--------------------------------------------------------------------------
|
| Specify the configured disk for storing the postman collection file.
|
*/
'disk' => 'local',
];