feat: add restructure enhancer

add restructure enhancer

Signed-off-by: Douglas McConnachie <[email protected]>

packages/openapi-v3/src/enhancers/index.ts

@@ -7,7 +7,7 @@ export * from './consolidate-schema.enhancer';
 export * from './default-deprecate-schema.enhancer';
 export * from './keys';
 export * from './prune-schema.enhancer';
+export * from './restructure-schema.enhancer';
 export * from './spec-enhancer.service';
 export * from './tags-schema.enhancer';
 export * from './types';
-

packages/openapi-v3/src/enhancers/restructure-schema.enhancer.ts

@@ -0,0 +1,59 @@
+import {bind} from '@loopback/core';
+import {OpenApiSpec} from '../types';
+import {asSpecEnhancer, OASEnhancer} from './types';
+
+/**
+ * A spec enhancer to restructure the OpenAPI spec in an opinionated manner.
+ * (dougal83)
+ *
+ */
+@bind(asSpecEnhancer)
+export class RestructureEnhancer implements OASEnhancer {
+  name = 'restructure';
+
+  modifySpec(spec: OpenApiSpec): OpenApiSpec {
+    try {
+      return this.restructureSpec(spec);
+    } catch {
+      console.log('Restructure Enhancer failed, returned original spec.');
+      return spec;
+    }
+  }
+
+  /**
+   *  Structure OpenApiSpec in an opinionated manner
+   *
+   */
+  private restructureSpec(spec: OpenApiSpec): OpenApiSpec {
+    spec = Object.assign(
+      {
+        openapi: undefined,
+        info: undefined,
+        servers: undefined,
+        paths: undefined,
+        components: undefined,
+        tags: undefined,
+      },
+      spec,
+    );
+
+    Object.keys(spec.paths).forEach(path =>
+      Object.keys(spec.paths[path]).forEach(op => {
+        spec.paths[path][op] = Object.assign(
+          {
+            tags: undefined,
+            summary: undefined,
+            description: undefined,
+            operationId: undefined,
+            parameters: undefined,
+            responses: undefined,
+            depreciated: undefined,
+          },
+          spec.paths[path][op],
+        );
+      }),
+    );
+
+    return spec;
+  }
+}

packages/rest/src/rest.server.ts

@@ -21,6 +21,7 @@ import {
   OpenApiSpec,
   OperationObject,
   PruneEnhancer,
+  RestructureEnhancer,
   ServerObject,
   TagsEnhancer,
 } from '@loopback/openapi-v3';
@@ -728,6 +729,8 @@ export class RestServer extends Context implements Server, HttpServerLike {
     spec = tagsEnhancer.modifySpec(spec);
     const defaultDeprecateEnhancer = new DefaultDeprecateEnhancer();
     spec = defaultDeprecateEnhancer.modifySpec(spec);
+    const restructureEnhancer = new RestructureEnhancer();
+    spec = restructureEnhancer.modifySpec(spec);
 
     return spec;
   }