Feature: allow passing "patch" option to "swagger2openapi" (#283)

Co-authored-by: cassel <[email protected]>

Author: 2 people

README.md

@@ -63,6 +63,7 @@ Options:
   --default-response <type>     default type for empty response schema (default: "void")
   --type-prefix <string>        data contract name prefix (default: "")
   --type-suffix <string>        data contract name suffix (default: "")
+  --patch                       fix up small errors in the swagger source definition (default: false)
   -h, --help                    display help for command
 ```
 

index.d.ts

@@ -112,6 +112,11 @@ interface GenerateApiParams {
    *  extra templates
    */
   extraTemplates?: { name: string; path: string }[];
+
+  /**
+   * fix up small errors in the swagger source definition
+   */
+  patch?: boolean;
 }
 
 export interface Hooks {

index.js

@@ -76,7 +76,8 @@ program
     "--clean-output",
     "clean output folder before generate api. WARNING: May cause data loss",
     false,
-  );
+  )
+  .option("--patch", "fix up small errors in the swagger source definition", false);
 
 program.parse(process.argv);
 
@@ -107,6 +108,7 @@ const {
   silent,
   typePrefix,
   typeSuffix,
+  patch,
 } = program;
 
 generateApi({
@@ -137,4 +139,5 @@ generateApi({
   silent: !!silent,
   typePrefix,
   typeSuffix,
+  patch: !!patch,
 });

package.json

@@ -39,7 +39,8 @@
     "test:--axios--single-http-client": "node tests/spec/axiosSingleHttpClient/test.js",
     "test:--type-suffix--type-prefix": "node tests/spec/typeSuffixPrefix/test.js",
     "test:partialBaseTemplate": "node tests/spec/partialBaseTemplate/test.js",
-    "test:partialDefaultTemplate": "node tests/spec/partialDefaultTemplate/test.js"
+    "test:partialDefaultTemplate": "node tests/spec/partialDefaultTemplate/test.js",
+    "test:--patch": "node tests/spec/patch/test.js"
   },
   "author": "acacode",
   "license": "MIT",

src/config.js

@@ -83,6 +83,7 @@ const config = {
   silent: false,
   typePrefix: "",
   typeSuffix: "",
+  patch: false,
   componentTypeNameResolver: new NameResolver([]),
 };
 

src/index.js

@@ -56,6 +56,7 @@ module.exports = {
     silent = config.silent,
     typePrefix = config.typePrefix,
     typeSuffix = config.typeSuffix,
+    patch = config.patch,
   }) =>
     new Promise((resolve, reject) => {
       addToConfig({
@@ -85,10 +86,11 @@ module.exports = {
         toJS: translateToJavaScript,
         typePrefix,
         typeSuffix,
+        patch,
       });
       (spec
-        ? convertSwaggerObject(spec)
-        : getSwaggerObject(input, url, disableStrictSSL, disableProxy)
+        ? convertSwaggerObject(spec, { patch })
+        : getSwaggerObject(input, url, disableStrictSSL, disableProxy, { patch })
       )
         .then(({ usageSchema, originalSchema }) => {
           const templatePaths = getTemplatePaths(config);

src/swagger.js

@@ -42,12 +42,18 @@ const getSwaggerFile = (pathToSwagger, urlToSwagger, disableStrictSSL, disablePr
     }
   });
 
-const getSwaggerObject = (pathToSwagger, urlToSwagger, disableStrictSSL, disableProxy) =>
+const getSwaggerObject = (
+  pathToSwagger,
+  urlToSwagger,
+  disableStrictSSL,
+  disableProxy,
+  converterOptions,
+) =>
   getSwaggerFile(pathToSwagger, urlToSwagger, disableStrictSSL, disableProxy).then((file) =>
-    convertSwaggerObject(parseSwaggerFile(file)),
+    convertSwaggerObject(parseSwaggerFile(file), converterOptions),
   );
 
-const convertSwaggerObject = (swaggerSchema) => {
+const convertSwaggerObject = (swaggerSchema, converterOptions) => {
   return new Promise((resolve) => {
     swaggerSchema.info = _.merge(
       {
@@ -63,6 +69,7 @@ const convertSwaggerObject = (swaggerSchema) => {
       converter.convertObj(
         swaggerSchema,
         {
+          ...converterOptions,
           warnOnly: true,
           refSiblings: "preserve",
           rbname: "requestBodyName",