feat: POST body uses as example in openapi

Author: joolfe

CHANGELOG.md

@@ -16,6 +16,3 @@
 ### Reverts
 
 * Revert "Testing commit lint" ([bd7d8c5](https://github.com/joolfe/postman-to-openapi/commit/bd7d8c5d42c83a0ba76907aeb6315461db763b34))
-
-
-

README.md

@@ -9,6 +9,9 @@ Or in other words, transform [this specification](https://schema.getpostman.com/
 - Postman Collection v2.1
 - OpenApi 3.0
 
+- POST request with JSON body.
+- Allow extract the api version from a collection general `variable`.
+
 ## Development
 
 This project use for development:

lib/index.js

@@ -7,15 +7,17 @@ async function postmanToOpenApi (input, output, { save = true }) {
   // TODO validate?
   const collectionFile = await readFile(input)
   const postmanJson = JSON.parse(collectionFile)
-  const { item: items, info: { name: title, description } } = postmanJson
+  const { item: items, info: { name: title, description }, variable } = postmanJson
+  const version = getVarValue(variable, 'version', '1.0.0')
   const paths = {}
 
   for (const item of items) {
-    const { request: { url: { path }, method, body }, name: summary } = item
+    const { request: { url: { path }, method, body, description }, name: summary } = item
     const compiledPath = '/' + path.join('/')
     if (!paths[compiledPath]) paths[compiledPath] = {}
     paths[compiledPath][method.toLowerCase()] = {
       summary,
+      ...(description ? { description } : {}),
       requestBody: parseBody(body),
       responses: {
         200: {
@@ -33,7 +35,7 @@ async function postmanToOpenApi (input, output, { save = true }) {
     info: {
       title,
       description,
-      version: '1.0.0'
+      version
     },
     paths
   }
@@ -66,4 +68,9 @@ function parseBody (body) {
   }
 }
 
+function getVarValue (variables, name, def) {
+  const variable = variables.find(({ key }) => key === name)
+  return variable ? variable.value : def
+}
+
 module.exports = postmanToOpenApi

test/index.spec.js

@@ -11,7 +11,7 @@ const OUTPUT_PATH = path.join(__dirname, '/openAPIRes.yml')
 const COLLECTION_BASIC = path.join(__dirname, '/resources/input/PostmantoOpenAPI.postman_collection.json')
 const EXPECTED_BASIC = readFileSync(path.join(__dirname, './resources/output/Basic.yml'), 'utf8')
 
-describe('First test', function () {
+describe('Library specs', function () {
   afterEach('remove file', function () {
     if (existsSync(OUTPUT_PATH)) {
       unlinkSync(OUTPUT_PATH)
@@ -20,7 +20,6 @@ describe('First test', function () {
 
   it('should work with a basic transform', async function () {
     const result = await postmanToOpenApi(COLLECTION_BASIC, OUTPUT_PATH, {})
-
     equal(EXPECTED_BASIC, result.slice(0, -1))
     ok(existsSync(OUTPUT_PATH))
   })

test/resources/input/PostmantoOpenAPI.postman_collection.json

@@ -7,7 +7,7 @@
 	},
 	"item": [
 		{
-			"name": "Post example",
+			"name": "Create a user",
 			"request": {
 				"method": "POST",
 				"header": [],
@@ -21,22 +21,22 @@
 					}
 				},
 				"url": {
-					"raw": "https://www.google.es/hola",
+					"raw": "https://api.io/users",
 					"protocol": "https",
 					"host": [
-						"www",
-						"google",
-						"es"
+						"api",
+						"io"
 					],
 					"path": [
-						"hola"
+						"users"
 					]
-				}
+				},
+				"description": "This is a post request with json body"
 			},
 			"response": []
 		},
 		{
-			"name": "Post example 2",
+			"name": "Create a post",
 			"request": {
 				"method": "POST",
 				"header": [],
@@ -50,15 +50,14 @@
 					}
 				},
 				"url": {
-					"raw": "https://www.google.es/hola",
+					"raw": "https://api.io/posts",
 					"protocol": "https",
 					"host": [
-						"www",
-						"google",
-						"es"
+						"api",
+						"io"
 					],
 					"path": [
-						"hola"
+						"posts"
 					]
 				}
 			},
@@ -87,5 +86,12 @@
 			}
 		}
 	],
+	"variable": [
+		{
+			"id": "cfcda50b-827a-4a48-8059-1344d044cba7",
+			"key": "version",
+			"value": "1.1.0"
+		}
+	],
 	"protocolProfileBehavior": {}
 }

test/resources/output/Basic.yml

@@ -2,11 +2,30 @@ openapi: 3.0.0
 info:
   title: Postman to OpenAPI
   description: 'Mi super test collection from postman '
-  version: 1.0.0
+  version: 1.1.0
 paths:
-  /hola:
+  /users:
     post:
-      summary: Post example 2
+      summary: Create a user
+      description: This is a post request with json body
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              example:
+                example: field
+                other:
+                  data1: 'yes'
+                  data2: 'no'
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json: {}
+  /posts:
+    post:
+      summary: Create a post
       requestBody:
         content:
           text/plain: {}