Merge pull request #65 from rcerljenko/master

Added boolean and file attribute type support

Author: kevincobain2000

resources/views/index.blade.php

@@ -289,6 +289,9 @@ class="inline-flex text-xs"
                                 @endif
                                 @if (str_contains($rule, 'boolean'))
                                 <span class="inline-flex items-center justify-center px-2 py-1 text-xs font-bold leading-none text-gray-800 bg-green-400 rounded">Boolean</span>
+                                @endif
+								@if (str_contains($rule, 'file') || str_contains($rule, 'image'))
+                                <span class="inline-flex items-center justify-center px-2 py-1 text-xs font-bold leading-none text-gray-800 bg-green-400 rounded">File</span>
                                 @endif
                             @endforeach
                         </td>
@@ -310,7 +313,7 @@ class="inline-flex text-xs"
                             <div class="font-mono">
                                 @foreach ($rules as $rule)
                                     @foreach (explode('|', $rule) as $r)
-                                        @if (!in_array($r, ['required', 'integer', 'string', 'boolean', 'array', 'nullable', 'bail']))
+                                        @if (!in_array($r, ['required', 'integer', 'string', 'boolean', 'array', 'nullable', 'bail', 'file', 'image']))
                                             {{$r}}
                                             @if (!$loop->last)
                                             <span class="text-gray-900 font-bold">|</span>
@@ -524,13 +527,17 @@ class="my-prism-editor"
                 isArray: null,
                 isDate: null,
                 isIn: null,
+				isBoolean: null,
+				isFile: null,
                 value: '',
             }
             rules.map(function(rule) {
                 validations.isRequired = rule.match(/required/)
                 validations.isDate = rule.match(/date/)
                 validations.isArray = rule.match(/array/)
                 validations.isString = rule.match(/string/)
+				validations.isBoolean = rule.match(/boolean/)
+				validations.isFile = rule.match(/file|image/)
                 if (rule.match(/integer/)) {
                     validations.isInteger = true
                 }
@@ -557,6 +564,12 @@ class="my-prism-editor"
             if (validations.isDate) {
                 validations.value = new Date(faker.date.between(new Date(), new Date())).toISOString().slice(0, 10)
             }
+			if (validations.isBoolean) {
+                validations.value = true
+            }
+			if (validations.isFile) {
+                validations.value = {}
+            }
 
             return validations
         }

src/LaravelRequestDocsToOpenApi.php

@@ -33,6 +33,7 @@ private function docsToOpenApi(array $docs)
     {
         $this->openApi['paths'] = [];
         foreach ($docs as $doc) {
+			$requestHasFile = false;
             $httpMethod = strtolower($doc['httpMethod']);
             $isGet    = $httpMethod == 'get';
             $isPost   = $httpMethod == 'post';
@@ -44,26 +45,45 @@ private function docsToOpenApi(array $docs)
 
             $this->openApi['paths'][$doc['uri']][$httpMethod]['responses'] = config('request-docs.open_api.responses', []);
 
-            if ($isGet) {
+			foreach ($doc['rules'] as $attribute => $rules) {
+                foreach ($rules as $rule) {
+					if ($isPost || $isPut || $isDelete) {
+						$requestHasFile = $this->attributeIsFile($rule);
+
+						if ($requestHasFile) {
+							break 2;
+						}
+					}
+				}
+			}
+
+			$contentType = $requestHasFile ? 'multipart/form-data' : 'application/json';
+
+			if ($isGet) {
                 $this->openApi['paths'][$doc['uri']][$httpMethod]['parameters'] = [];
             }
             if ($isPost || $isPut || $isDelete) {
-                $this->openApi['paths'][$doc['uri']][$httpMethod]['requestBody'] = $this->makeRequestBodyItem();
+                $this->openApi['paths'][$doc['uri']][$httpMethod]['requestBody'] = $this->makeRequestBodyItem($contentType);
             }
+
             foreach ($doc['rules'] as $attribute => $rules) {
                 foreach ($rules as $rule) {
                     if ($isGet) {
                         $parameter = $this->makeQueryParameterItem($attribute, $rule);
                         $this->openApi['paths'][$doc['uri']][$httpMethod]['parameters'][] = $parameter;
                     }
                     if ($isPost || $isPut || $isDelete) {
-                        $this->openApi['paths'][$doc['uri']][$httpMethod]['requestBody']['content']['application/json']['schema']['properties'][$attribute] = $this->makeRequestBodyContentPropertyItem($rule);
+                        $this->openApi['paths'][$doc['uri']][$httpMethod]['requestBody']['content'][$contentType]['schema']['properties'][$attribute] = $this->makeRequestBodyContentPropertyItem($rule);
                     }
                 }
             }
         }
     }
 
+	protected function attributeIsFile(string $rule)
+	{
+		return str_contains($rule, 'file') || str_contains($rule, 'image');
+	}
 
     protected function makeQueryParameterItem(string $attribute, string $rule): array
     {
@@ -80,12 +100,12 @@ protected function makeQueryParameterItem(string $attribute, string $rule): arra
         return $parameter;
     }
 
-    protected function makeRequestBodyItem(): array
+    protected function makeRequestBodyItem(string $contentType): array
     {
         $requestBody = [
             'description' => "Request body",
             'content'     => [
-                'application/json' => [
+                $contentType => [
                     'schema' => [
                         'type' => 'object',
                         'properties' => [],
@@ -98,22 +118,29 @@ protected function makeRequestBodyItem(): array
 
     protected function makeRequestBodyContentPropertyItem(string $rule): array
     {
+		$type = $this->getAttributeType($rule);
+
         return [
-            'type' => $this->getAttributeType($rule),
+            'type' => $type,
+			'nullable' => str_contains($rule, 'nullable'),
+			'format' => $this->attributeIsFile($rule) ? 'binary' : $type,
         ];
     }
 
 
     protected function getAttributeType(string $rule): string
     {
-        if (str_contains($rule, 'string')) {
+        if (str_contains($rule, 'string') || $this->attributeIsFile($rule)) {
             return 'string';
         }
         if (str_contains($rule, 'array')) {
             return 'array';
         }
         if (str_contains($rule, 'integer')) {
             return 'integer';
+        }
+		if (str_contains($rule, 'boolean')) {
+            return 'boolean';
         }
         return "object";
     }