Merge pull request #239 from joolfe/develop

feat: formdata and x-www-form-urlencoded support required indicator in postman field descriptor

lib/index.js

@@ -195,40 +195,41 @@ function parseBody (body = {}, method) {
         'text/plain': {}
       }
       break
-    case 'formdata':
+    case 'formdata': {
       content = {
-        'multipart/form-data': {
-          schema: {
-            type: 'object',
-            properties: body.formdata.reduce(mapFormData(), {})
-          }
-        }
+        'multipart/form-data': parseFormData(body.formdata)
       }
       break
+    }
     case 'urlencoded':
       content = {
-        'application/x-www-form-urlencoded': {
-          schema: {
-            properties: body.urlencoded.reduce(mapFormData(), {})
-          }
-        }
+        'application/x-www-form-urlencoded': parseFormData(body.urlencoded)
       }
       break
   }
   return { requestBody: { content } }
 }
 
-/* Accumulator function for form data values */
-function mapFormData () {
-  return (obj, { key, type, description, value }) => {
-    obj[key] = {
+/** Parse the body for create a form data structure */
+function parseFormData (data) {
+  const objectSchema = {
+    schema: {
+      type: 'object'
+    }
+  }
+  return data.reduce((obj, { key, type, description, value }) => {
+    const { schema } = obj
+    if (isRequired(description)) {
+      (schema.required = schema.required || []).push(key)
+    }
+    (schema.properties = schema.properties || {})[key] = {
       type: inferType(value),
       ...(description ? { description: description.replace(/ ?\[required\] ?/gi, '') } : {}),
       ...(value ? { example: value } : {}),
       ...(type === 'file' ? { format: 'binary' } : {})
     }
     return obj
-  }
+  }, objectSchema)
 }
 
 /**
@@ -600,6 +601,15 @@ async function resolveInput (input) {
   }
 }
 
+/**
+ * return if the provided text contains the '[required]' mark
+ * @param {*} text The text where we should look for the required mark
+ * @returns boolean
+ */
+function isRequired (text) {
+  return /\[required\]/gi.test(text)
+}
+
 postmanToOpenApi.version = version
 
 module.exports = postmanToOpenApi

package.json

@@ -1,6 +1,6 @@
 {
   "name": "postman-to-openapi",
-  "version": "2.7.2",
+  "version": "2.8.0",
   "description": "Convert postman collection to OpenAPI spec",
   "main": "lib/index.js",
   "types": "types/index.d.ts",

test/resources/output/FormData.yml

@@ -16,6 +16,9 @@ paths:
           multipart/form-data:
             schema:
               type: object
+              required:
+                - name
+                - email
               properties:
                 name:
                   type: string

test/resources/output/FormUrlencoded.yml

@@ -14,6 +14,11 @@ paths:
         content:
           application/x-www-form-urlencoded:
             schema:
+              type: object
+              required:
+                - name
+                - email
+                - password
               properties:
                 name:
                   type: string