Merge pull request #28 from AndreasElia/chore/readme

Author: tomirons

config/api-postman.php

@@ -3,44 +3,59 @@
 return [
 
     /*
-     * Base URL.
-     *
-     * The base URL for all of your endpoints.
-     */
+    |--------------------------------------------------------------------------
+    | 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.
-     */
+    |--------------------------------------------------------------------------
+    | 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
+    |--------------------------------------------------------------------------
+    |
+    | 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
+    |--------------------------------------------------------------------------
+    |
+    | 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
+    |--------------------------------------------------------------------------
+    |
+    | The headers applied to all routes within the collection.
+    |
+    */
 
     'headers' => [
         [
@@ -54,36 +69,50 @@
     ],
 
     /*
-     * Enable Form Data.
-     *
-     * Determines whether or not form data should be handled.
-     */
+    |--------------------------------------------------------------------------
+    | Enable Form Data
+    |--------------------------------------------------------------------------
+    |
+    | Determines whether or not form data should be handled.
+    |
+    */
 
     'enable_formdata' => false,
 
     /*
-     * Form Data.
-     *
-     * The key/values to requests for form data dummy information.
-     */
+    |--------------------------------------------------------------------------
+    | Form Data
+    |--------------------------------------------------------------------------
+    |
+    | The key/values to requests for form data dummy information.
+    |
+    */
 
     'formdata' => [
         // 'email' => '[email protected]',
         // 'password' => 'changeme',
     ],
 
     /*
-     * Include Middleware.
-     *
-     * The middleware items you want to include for export.
-     */
+    |--------------------------------------------------------------------------
+    | 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 Driver
+    |--------------------------------------------------------------------------
+    |
+    | Specify the configured disk for storing the postman collection file.
+    |
+    */
+
     'disk' => 'local',
+
 ];