Merge pull request #147 from readmeio/feature/x-headers

Add support for x-headers extension

example/swagger-files/x-headers.json

@@ -0,0 +1,32 @@
+{
+  "openapi": "3.0.0",
+  "servers": [
+    {
+      "url": "http://httpbin.org"
+    }
+  ],
+  "info": {
+    "version": "1.0.0",
+    "title": "x-headers demo"
+  },
+  "paths": {
+    "/post": {
+      "post": {
+        "summary": "Should send static x-headers with the request",
+        "description": "",
+        "parameters": [],
+        "responses": {
+          "200": {
+            "description": "Successful"
+          }
+        }
+      }
+    }
+  },
+  "x-headers": [
+    {
+      "key": "x-api-key",
+      "value": "static-value"
+    }
+  ]
+}

packages/api-explorer/__tests__/lib/oas-to-har.test.js

@@ -1184,3 +1184,18 @@ describe('content-type & accept header', () => {
     ).toEqual([{ name: 'Content-Type', value: 'application/json' }]);
   });
 });
+
+describe('x-headers', () => {
+  it('should append any static headers to the request', () => {
+    expect(
+      oasToHar({
+        'x-headers': [
+          {
+            key: 'x-api-key',
+            value: '123456',
+          },
+        ],
+      }).log.entries[0].request.headers,
+    ).toEqual([{ name: 'x-api-key', value: '123456' }]);
+  });
+});

packages/api-explorer/src/lib/oas-to-har.js

@@ -160,6 +160,16 @@ module.exports = (
     });
   }
 
+  // x-headers static headers
+  if (oas['x-headers']) {
+    oas['x-headers'].forEach(header => {
+      har.headers.push({
+        name: header.key,
+        value: String(header.value),
+      });
+    });
+  }
+
   const schema = getSchema(pathOperation, oas) || { schema: {} };
 
   function stringify(json) {