open api security option added

Author: hafijul233

config/request-docs.php

@@ -161,6 +161,16 @@
                 ],
             ],
         ],
+        //openapi export with security configuration,
+        // if type set null then doc will exclude global security schema.
+        // Ref: https://spec.openapis.org/oas/v3.0.3#security-scheme-object
+        'security' => [
+            //available options [null, bearer, basic, apikey]
+            'type' => 'bearer',
+            //Note: only works for "apikey", available options [query, header, cookie]
+            'position' => 'header',
+            'key_name' => 'api_key'
+        ],
     ],
 
     //export request docs as json file from terminal

src/LaravelRequestDocsToOpenApi.php

@@ -23,6 +23,7 @@ public function openApi(array $docs): LaravelRequestDocsToOpenApi
         ];
 
         $this->docsToOpenApi($docs);
+        $this->appendGlobalSecurityScheme();
         return $this;
     }
 
@@ -190,6 +191,48 @@ protected function getAttributeType(string $rule): string
         return "object";
     }
 
+    protected function appendGlobalSecurityScheme(): void
+    {
+        $securityType = config('request-docs.open_api.security.type');
+
+        if ($securityType == null) {
+            return;
+        }
+
+        switch ($securityType) {
+            case 'bearer':
+                $this->openApi['components']['securitySchemes']['bearerAuth'] = [
+                    'type' => 'http',
+                    'scheme' => 'bearer'
+                ];
+                $this->openApi['security'][]                                  = [
+                    'bearerAuth' => []
+                ];
+                break;
+
+            case 'basic':
+                $this->openApi['components']['securitySchemes']['basicAuth'] = [
+                    'type' => 'http',
+                    'scheme' => 'basic'
+                ];
+                $this->openApi['security'][]                                 = [
+                    'basicAuth' => []
+                ];
+                break;
+
+            case 'apikey':
+                $this->openApi['components']['securitySchemes']['apiKeyAuth'] = [
+                    'type' => 'apiKey',
+                    'name' => config('request-docs.open_api.security.key_name', 'api_key'),
+                    'in' => config('request-docs.open_api.security.position', 'header')
+                ];
+                $this->openApi['security'][]                                  = ['apiKeyAuth' => []];
+                break;
+
+            default:
+                break;
+        }
+    }
     /**
      * @codeCoverageIgnore
      */