feat: Infer the type of parameters #37

README.md

@@ -11,6 +11,9 @@ Or in other words, transform [this specification](https://schema.getpostman.com/
 
 - POST request with JSON body.
 - Allow extract the api version from a collection general `variable`.
+- Customize general API information.
+- Transform query and headers parameters.
+- Automatic infer types from query and headers parameters. 
 
 ## Development
 

lib/index.js

@@ -108,7 +108,7 @@ function mapParameters (type) {
     parameters.push({
       name: key,
       in: type,
-      schema: { type: 'string' },
+      schema: { type: inferType(value) },
       ...(description ? { description } : {}),
       ...(value ? { example: value } : {})
     })
@@ -121,4 +121,12 @@ function getVarValue (variables, name, def) {
   return variable ? variable.value : def
 }
 
+/* calculate the type of a variable based on OPenApi types */
+function inferType (value) {
+  if (/^\d+$/.test(value)) return 'integer'
+  if (/-?\d+\.\d+/.test(value)) return 'number'
+  if (/^(true|false)$/.test(value)) return 'boolean'
+  return 'string'
+}
+
 module.exports = postmanToOpenApi

test/resources/input/GetMethods.json

@@ -12,7 +12,7 @@
 				"method": "GET",
 				"header": [],
 				"url": {
-					"raw": "https://api.io/users?age=45&name=Jhon&review=true",
+					"raw": "https://api.io/users?age=45&name=Jhon&review=true&number=23.56",
 					"protocol": "https",
 					"host": [
 						"api",
@@ -36,6 +36,11 @@
 							"key": "review",
 							"value": "true",
 							"description": "Indicate if should be reviewed or not"
+						},
+						{
+							"key": "number",
+							"value": "23.56",
+							"description": "This is a number"
 						}
 					]
 				},

test/resources/output/GetMethods.yml

@@ -14,7 +14,7 @@ paths:
         - name: age
           in: query
           schema:
-            type: string
+            type: integer
           description: Filter by age
           example: '45'
         - name: name
@@ -26,9 +26,15 @@ paths:
         - name: review
           in: query
           schema:
-            type: string
+            type: boolean
           description: Indicate if should be reviewed or not
           example: 'true'
+        - name: number
+          in: query
+          schema:
+            type: number
+          description: This is a number
+          example: '23.56'
       responses:
         '200':
           description: Successful response

test/resources/output/Headers.yml

@@ -36,7 +36,7 @@ paths:
         - name: age
           in: query
           schema:
-            type: string
+            type: integer
           description: Filter by age
           example: '45'
         - name: name
@@ -48,7 +48,7 @@ paths:
         - name: review
           in: query
           schema:
-            type: string
+            type: boolean
           description: Indicate if should be reviewed or not
           example: 'true'
       responses: