Add relationship in schema generation

Author: Mezatsong

src/Definitions/DefinitionGenerator.php

@@ -1,12 +1,15 @@
-<?php namespace Mezatsong\SwaggerDocs\Definitions;
+<?php 
+
+namespace Mezatsong\SwaggerDocs\Definitions;
 
 use Doctrine\DBAL\Types\Type;
 use Illuminate\Container\Container;
+use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Facades\DB;
 use Illuminate\Support\Facades\File;
 use Illuminate\Support\Facades\Schema;
-use Illuminate\Database\Eloquent\Model;
 use Illuminate\Support\Arr;
+use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Str;
 use ReflectionClass;
 
@@ -78,6 +81,17 @@ function generateSchemas(): array {
                 $appends = $reflection->getProperty('appends');
                 $appends->setAccessible(true);
 
+                $relations = collect($reflection->getMethods())
+                    ->filter(
+                        fn($method) => !empty($method->getReturnType()) &&
+                            str_contains(
+                                $method->getReturnType(), 
+                                \Illuminate\Database\Eloquent\Relations::class
+                            )
+                    )
+                    ->pluck('name')
+                    ->all();
+
                 $table = $obj->getTable();
                 $list = Schema::getColumnListing($table);
                 $list = array_diff($list, $obj->getHidden());
@@ -126,16 +140,33 @@ function generateSchemas(): array {
                     }
                 }
 
-                foreach ($with->getValue($obj) as $item) {
-                    $class = get_class($obj->{$item}()->getModel());
-                    $properties[$item] = [
+                foreach ($relations as $relationName) {
+                    $relatedClass = get_class($obj->{$relationName}()->getRelated());
+                    $refObject = [
                         'type' => 'object',
-                        '$ref' => '#/components/schemas/' . last(explode('\\', $class)),
+                        '$ref' => '#/components/schemas/' . last(explode('\\', $relatedClass)),
                     ];
+                    
+                    $resultsClass = get_class((object) ($obj->{$relationName}()->getResults()));
+
+                    if (str_contains($resultsClass, \Illuminate\Database\Eloquent\Collection::class)) {
+                        $properties[$relationName] = [
+                            'type' => 'array',
+                            'items'=> $refObject
+                        ];
+                    } else {
+                        $properties[$relationName] = $refObject;
+                    }
                 }
+                
+                $required = array_merge($required, $with->getValue($obj));
 
                 foreach ($appends->getValue($obj) as $item) {
                     $methodeName = 'get' . ucfirst(Str::camel($item)) . 'Attribute';
+                    if ( ! $reflection->hasMethod($methodeName)) {
+                        Log::warning("[Mezatsong\SwaggerDocs] Method $model::$methodeName not found while parsing '$item' attribute");
+                        continue;
+                    }
                     $reflectionMethod = $reflection->getMethod($methodeName);
                     $returnType = $reflectionMethod->getReturnType();
 

src/SwaggerServiceProvider.php

@@ -1,7 +1,10 @@
-<?php namespace Mezatsong\SwaggerDocs;
+<?php 
+
+namespace Mezatsong\SwaggerDocs;
 
 use Illuminate\Support\Arr;
 use Illuminate\Support\Facades\DB;
+use Illuminate\Support\Facades\Log;
 use Illuminate\Support\Facades\Validator;
 use Illuminate\Support\ServiceProvider;
 use Mezatsong\SwaggerDocs\Commands\GenerateSwaggerDocumentation;
@@ -49,9 +52,12 @@ public function boot(): void {
         $this->loadValidationRules();
 
         try {
-            DB::getDoctrineSchemaManager()->getDatabasePlatform()->registerDoctrineTypeMapping('enum', 'string');
+            DB::connection()
+                ->getDoctrineConnection()
+                ->getDatabasePlatform()
+                ->registerDoctrineTypeMapping('enum', 'string');
         } catch (\Exception $e) {
-            error_log('Could not register enum type as string because of connexion error.');
+            Log::error('[Mezatsong\SwaggerDocs] Could not register enum type as string because of connexion error.');
         }
 
         if (file_exists($file = __DIR__ . '/helpers.php')) {