Merge pull request #55 from nandi95/feature/middlewares

Add components middleware

Author: vyuldashev

config/openapi.php

@@ -46,6 +46,9 @@
                 'paths' => [
                     //
                 ],
+                'components' => [
+                    //
+                ],
             ],
 
         ],

docs/middlewares.md

@@ -1,2 +1,18 @@
 # Middlewares
 
+Middlewares are an optional bit of logic to transform the given data at various lifecycle points.
+
+### Path
+
+To add a path middleware create a class that implements `\Vyuldashev\LaravelOpenApi\Contracts\PathMiddleware` then register it by referencing it in the  `openapi.collections.default.middlewares.paths` config array like `MyPathMiddleware::class`
+
+Available lifecycle points are:
+ - `before` - after collecting all `RouteInformation` but before processing them.
+ - `after` - after the `PathItem` has been built.
+
+### Component
+
+To add a path middleware create a class that implements `\Vyuldashev\LaravelOpenApi\Contracts\ComponentMiddleware` then register it by referencing it in the  `openapi.collections.default.middlewares.components` config array like `MyComponentMiddleware::class`
+
+Available lifecycle points are:
+- `after` - after the `Components` has been built.

src/Builders/ComponentsBuilder.php

@@ -32,8 +32,10 @@ public function __construct(
         $this->securitySchemesBuilder = $securitySchemesBuilder;
     }
 
-    public function build(string $collection = Generator::COLLECTION_DEFAULT): ?Components
-    {
+    public function build(
+        string $collection = Generator::COLLECTION_DEFAULT,
+        array $middlewares = []
+    ): ?Components {
         $callbacks = $this->callbacksBuilder->build($collection);
         $requestBodies = $this->requestBodiesBuilder->build($collection);
         $responses = $this->responsesBuilder->build($collection);
@@ -71,6 +73,14 @@ public function build(string $collection = Generator::COLLECTION_DEFAULT): ?Comp
             $components = $components->securitySchemes(...$securitySchemes);
         }
 
-        return $hasAnyObjects ? $components : null;
+        if (! $hasAnyObjects) {
+            return null;
+        }
+
+        foreach ($middlewares as $middleware) {
+            app($middleware)->after($components);
+        }
+
+        return $components;
     }
 }

src/Contracts/ComponentMiddleware.php

@@ -0,0 +1,10 @@
+<?php
+
+namespace Vyuldashev\LaravelOpenApi\Contracts;
+
+use GoldSpecDigital\ObjectOrientedOAS\Objects\Components;
+
+interface ComponentMiddleware
+{
+    public function after(Components $components): void;
+}

src/Generator.php

@@ -47,7 +47,7 @@ public function generate(string $collection = self::COLLECTION_DEFAULT): OpenApi
         $servers = $this->serversBuilder->build(Arr::get($this->config, 'collections.'.$collection.'.servers', []));
         $tags = $this->tagsBuilder->build(Arr::get($this->config, 'collections.'.$collection.'.tags', []));
         $paths = $this->pathsBuilder->build($collection, Arr::get($middlewares, 'paths', []));
-        $components = $this->componentsBuilder->build($collection);
+        $components = $this->componentsBuilder->build($collection, Arr::get($middlewares, 'components', []));
 
         return OpenApi::create()
             ->openapi(OpenApi::OPENAPI_3_0_2)