add X-TagGroups Extension

Author: moretalk

src/openApi/v2/index.ts

@@ -1,4 +1,6 @@
 import type { Client } from '../../client/interfaces/Client';
+import { Model } from '../../client/interfaces/Model';
+import { Service } from '../../client/interfaces/Service';
 import type { OpenApi } from './interfaces/OpenApi';
 import { getModels } from './parser/getModels';
 import { getServer } from './parser/getServer';
@@ -11,10 +13,10 @@ import { getServiceVersion } from './parser/getServiceVersion';
  * @param openApi The OpenAPI spec  that we have loaded from disk.
  */
 export function parse(openApi: OpenApi): Client {
-    const version = getServiceVersion(openApi.info.version);
-    const server = getServer(openApi);
-    const models = getModels(openApi);
-    const services = getServices(openApi);
+    const version: string = getServiceVersion(openApi.info.version);
+    const server: string = getServer(openApi);
+    const models: Model[] = getModels(openApi);
+    const services: Service[] = getServices(openApi);
 
     return { version, server, models, services };
 }

src/openApi/v2/interfaces/Extensions/WithXTagGroupsExtension.d.ts

@@ -0,0 +1,8 @@
+export interface WithXTagGroupsExtension {
+    'x-tagGroups'?: XTagGroup[];
+}
+
+export interface XTagGroup {
+    name: string;
+    tags: string[];
+}

src/openApi/v2/interfaces/OpenApi.d.ts

@@ -1,4 +1,5 @@
 import type { Dictionary } from '../../../utils/types';
+import { WithXTagGroupsExtension } from './Extensions/WithXTagGroupsExtension';
 import type { OpenApiExternalDocs } from './OpenApiExternalDocs';
 import type { OpenApiInfo } from './OpenApiInfo';
 import type { OpenApiParameter } from './OpenApiParameter';
@@ -12,7 +13,7 @@ import type { OpenApiTag } from './OpenApiTag';
 /**
  * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md
  */
-export interface OpenApi {
+export interface OpenApi extends WithXTagGroupsExtension {
     swagger: string;
     info: OpenApiInfo;
     host?: string;

src/openApi/v2/parser/getServices.ts

@@ -9,6 +9,8 @@ import { getOperationParameters } from './getOperationParameters';
  */
 export function getServices(openApi: OpenApi): Service[] {
     const services = new Map<string, Service>();
+    const tagGroups: string[] | undefined = openApi['x-tagGroups'] && openApi['x-tagGroups'][0]?.tags;
+
     for (const url in openApi.paths) {
         if (openApi.paths.hasOwnProperty(url)) {
             // Grab path and parse any global path parameters
@@ -28,7 +30,13 @@ export function getServices(openApi: OpenApi): Service[] {
                         case 'patch':
                             // Each method contains an OpenAPI operation, we parse the operation
                             const op = path[method]!;
-                            const tags = op.tags?.filter(unique) || ['Service'];
+                            let tags = op.tags?.filter(unique) || ['Service'];
+
+                            //Remove Tags that are not in the x-tagGroups Extension
+                            if (tagGroups) {
+                                tags = tags.filter(tag => tagGroups.includes(tag));
+                            }
+
                             tags.forEach(tag => {
                                 const operation = getOperation(openApi, url, method, tag, op, pathParams);
 

src/openApi/v3/index.ts

@@ -1,4 +1,6 @@
 import type { Client } from '../../client/interfaces/Client';
+import { Model } from '../../client/interfaces/Model';
+import { Service } from '../../client/interfaces/Service';
 import type { OpenApi } from './interfaces/OpenApi';
 import { getModels } from './parser/getModels';
 import { getServer } from './parser/getServer';
@@ -11,10 +13,10 @@ import { getServiceVersion } from './parser/getServiceVersion';
  * @param openApi The OpenAPI spec  that we have loaded from disk.
  */
 export function parse(openApi: OpenApi): Client {
-    const version = getServiceVersion(openApi.info.version);
-    const server = getServer(openApi);
-    const models = getModels(openApi);
-    const services = getServices(openApi);
+    const version: string = getServiceVersion(openApi.info.version);
+    const server: string = getServer(openApi);
+    const models: Model[] = getModels(openApi);
+    const services: Service[] = getServices(openApi);
 
     return { version, server, models, services };
 }

src/openApi/v3/interfaces/Extensions/WithXTagGroupsExtension.d.ts

@@ -0,0 +1,8 @@
+export interface WithXTagGroupsExtension {
+    'x-tagGroups'?: XTagGroup[];
+}
+
+export interface XTagGroup {
+    name: string;
+    tags: string[];
+}

src/openApi/v3/interfaces/OpenApi.d.ts

@@ -1,3 +1,4 @@
+import { WithXTagGroupsExtension } from './Extensions/WithXTagGroupsExtension';
 import type { OpenApiComponents } from './OpenApiComponents';
 import type { OpenApiExternalDocs } from './OpenApiExternalDocs';
 import type { OpenApiInfo } from './OpenApiInfo';
@@ -9,7 +10,7 @@ import type { OpenApiTag } from './OpenApiTag';
 /**
  * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md
  */
-export interface OpenApi {
+export interface OpenApi extends WithXTagGroupsExtension {
     openapi: string;
     info: OpenApiInfo;
     servers?: OpenApiServer[];

src/openApi/v3/parser/getServices.ts

@@ -9,6 +9,8 @@ import { getOperationParameters } from './getOperationParameters';
  */
 export function getServices(openApi: OpenApi): Service[] {
     const services = new Map<string, Service>();
+    const tagGroups: string[] | undefined = openApi['x-tagGroups'] && openApi['x-tagGroups'][0]?.tags;
+
     for (const url in openApi.paths) {
         if (openApi.paths.hasOwnProperty(url)) {
             // Grab path and parse any global path parameters
@@ -28,7 +30,14 @@ export function getServices(openApi: OpenApi): Service[] {
                         case 'patch':
                             // Each method contains an OpenAPI operation, we parse the operation
                             const op = path[method]!;
-                            const tags = op.tags?.filter(unique) || ['Service'];
+
+                            let tags = op.tags?.filter(unique) || ['Service'];
+
+                            //Remove Tags that are not in the x-tagGroups Extension
+                            if (tagGroups) {
+                                tags = tags.filter(tag => tagGroups.includes(tag));
+                            }
+
                             tags.forEach(tag => {
                                 const operation = getOperation(openApi, url, method, tag, op, pathParams);