fix: fallback to parsing non-json raw body as text (#153)

lib/index.js

@@ -144,12 +144,22 @@ function parseBody (body = {}, method) {
   switch (mode) {
     case 'raw': {
       const { raw: { language } } = options
+
+      let example = ''
       if (language === 'json') {
+        if (raw) {
+          try {
+            example = JSON.parse(raw)
+          } catch (e) {
+            example = raw
+          }
+        }
+
         content = {
           'application/json': {
             schema: {
               type: 'object',
-              example: raw ? JSON.parse(raw) : ''
+              example
             }
           }
         }

test/index.spec.js

@@ -10,6 +10,7 @@ const { version } = require('../package.json')
 const OUTPUT_PATH = path.join(__dirname, '/openAPIRes.yml')
 
 const COLLECTION_NO_OPTIONS = './test/resources/input/NoOptionsInBody.json'
+const COLLECTION_RAW_BODY = './test/resources/input/RawBody.json'
 
 const EXPECTED_BASIC = readFileSync('./test/resources/output/Basic.yml', 'utf8')
 const EXPECTED_INFO_OPTS = readFileSync('./test/resources/output/InfoOpts.yml', 'utf8')
@@ -53,6 +54,7 @@ const EXPECTED_FORM_URLENCODED = readFileSync('./test/resources/output/FormUrlen
 const EXPECTED_VARIABLES = readFileSync('./test/resources/output/Variables.yml', 'utf8')
 const EXPECTED_VARIABLES_ADDITIONAL = readFileSync('./test/resources/output/VariablesAdditional.yml', 'utf8')
 const EXPECTED_BASEPATH_VAR = readFileSync('./test/resources/output/BasepathVar.yml', 'utf8')
+const EXPECTED_RAW_BODY = readFileSync('./test/resources/output/RawBody.yml', 'utf8')
 
 const AUTH_DEFINITIONS = {
   myCustomAuth: {
@@ -459,6 +461,11 @@ describe('Library specs', function () {
     equal(result, EXPECTED_BASIC)
   })
 
+  it('should try to parse raw body as json but fallback to text', async function () {
+    const result = await postmanToOpenApi(COLLECTION_RAW_BODY, OUTPUT_PATH, {})
+    equal(result, EXPECTED_RAW_BODY)
+  })
+
   it('should expose the version of the library', async function () {
     equal(postmanToOpenApi.version, version)
   })

test/resources/input/RawBody.json

@@ -0,0 +1,37 @@
+{
+  "info": {
+    "_postman_id": "2a45baa5-352f-4831-8483-1a0fcbc7da37",
+    "name": "Postman to OpenAPI",
+    "description": "Mi super test collection from postman",
+    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+  },
+  "item": [
+    {
+      "name": "Test Raw Body",
+      "request": {
+        "method": "POST",
+        "header": [],
+        "body": {
+          "mode": "raw",
+          "raw": "testesttestest"
+        },
+        "url": {
+          "raw": "https://api.io/test",
+          "protocol": "https",
+          "host": [
+            "api",
+            "io"
+          ],
+          "path": [
+            "test"
+          ]
+        },
+        "description": "Test Raw Body"
+      },
+      "response": []
+    }
+  ],
+  "event": [],
+  "variable": [],
+  "protocolProfileBehavior": {}
+}

test/resources/output/RawBody.yml

@@ -0,0 +1,25 @@
+openapi: 3.0.0
+info:
+  title: Postman to OpenAPI
+  description: Mi super test collection from postman
+  version: 1.0.0
+servers:
+  - url: https://api.io
+paths:
+  /test:
+    post:
+      tags:
+        - default
+      summary: Test Raw Body
+      description: Test Raw Body
+      requestBody:
+        content:
+          application/json:
+            schema:
+              type: object
+              example: testesttestest
+      responses:
+        '200':
+          description: Successful response
+          content:
+            application/json: {}