feat: add custom generator to generate only required url paths

Author: romantech48

src/generateCustomSpec.ts

@@ -0,0 +1,88 @@
+import { OpenApi } from './openApi/v3/interfaces/OpenApi';
+import { OpenApiMediaType } from './openApi/v3/interfaces/OpenApiMediaType';
+import { OpenApiOperation } from './openApi/v3/interfaces/OpenApiOperation';
+import { OpenApiParameter } from './openApi/v3/interfaces/OpenApiParameter';
+import { OpenApiSchema } from './openApi/v3/interfaces/OpenApiSchema';
+import { OpenApiServer } from './openApi/v3/interfaces/OpenApiServer';
+import { getOpenApiSpec } from './utils/getOpenApiSpec';
+import { Dictionary } from './utils/types';
+
+export const generateCustomSpec = async (gen: any, input: string, output: string, config: Record<string, unknown>) => {
+    const getSchemaRefFromContent = (content: OpenApiMediaType): string => {
+        let ref: string = '';
+
+        ref = content.$ref || content.schema?.$ref || content.schema?.items?.$ref || '';
+
+        return ref.split('/').slice(-1)[0];
+    };
+
+    const list: OpenApi = await getOpenApiSpec(input);
+
+    const requiredPathsList: string[] = ['/api/agreement', '/api/agreement/{id}'];
+
+    const requiredPaths: OpenApi['paths'] = {};
+
+    for (const path in list.paths) {
+        if (requiredPathsList.some(it => it === path)) {
+            requiredPaths[path] = list.paths[path];
+        }
+    }
+
+    const requiredSchemasSet: Set<string> = new Set();
+
+    for (const pathName in requiredPaths) {
+        const pathElement = requiredPaths[pathName];
+
+        const openApiPathValues = Object.values(pathElement) as (
+            | OpenApiOperation
+            | OpenApiServer
+            | OpenApiParameter
+            | string
+        )[];
+
+        openApiPathValues.forEach(requestMethodData => {
+            if (typeof requestMethodData !== 'string') {
+                if (!('url' in requestMethodData)) {
+                    if ('parameters' in requestMethodData) {
+                        // add schemas from {apiPath}/{method}/parameters
+                        requestMethodData.parameters?.forEach(parameter =>
+                            requiredSchemasSet.add(getSchemaRefFromContent(parameter))
+                        );
+                    }
+                    if ('responses' in requestMethodData) {
+                        const responsesCodeData = Object.values(requestMethodData.responses);
+
+                        responsesCodeData.forEach(response => {
+                            const contentTypeData = Object.values(response.content ?? {});
+
+                            // add schemas from {apiPath}/{method}/responses/{responseType}/content
+                            contentTypeData.forEach(content => {
+                                requiredSchemasSet.add(getSchemaRefFromContent(content));
+                            });
+                        });
+                    }
+                }
+            }
+        });
+    }
+
+    const requiredSchemas: Dictionary<OpenApiSchema> = {};
+
+    if (list && list.components && list.components.schemas) {
+        for (const schema in list.components.schemas) {
+            if (requiredSchemasSet.has(schema)) {
+                requiredSchemas[schema] = list.components.schemas[schema];
+            }
+        }
+    }
+
+    const listWithRequiredPaths: OpenApi = {
+        ...list,
+        paths: requiredPaths,
+        components: {
+            schemas: requiredSchemas,
+        },
+    };
+
+    await gen(listWithRequiredPaths, output);
+};

src/index.ts

@@ -9,6 +9,7 @@ import { postProcessClient } from './utils/postProcessClient';
 import { registerHandlebarTemplates } from './utils/registerHandlebarTemplates';
 import { writeClient } from './utils/writeClient';
 
+export { generateCustomSpec } from './generateCustomSpec';
 export { HttpClient } from './HttpClient';
 export { Indent } from './Indent';
 

test/index.js

@@ -59,6 +59,7 @@ const generateRealWorldSpecs = async () => {
 const main = async () => {
     await generate('./test/spec/v2.json', './test/generated/v2/');
     await generate('./test/spec/v3.json', './test/generated/v3/');
+    await OpenAPI.generateCustomSpec(generate, './test/spec/saddlebackApi.json', './test/generated/saddleback/');
     // await generateRealWorldSpecs();
 };