Support x-www-form-urlencoded request bodies

Signed-off-by: Alan Cha <[email protected]>

Author: Alan-Cha

packages/openapi-to-graphql/lib/oas_3_tools.js

@@ -67,6 +67,7 @@
     "@types/request": "^2.48.1",
     "debug": "^4.1.0",
     "deep-equal": "^1.0.1",
+    "form-urlencoded": "^4.1.1",
     "graphql-type-json": "^0.2.1",
     "jsonpath-plus": "^0.18.0",
     "oas-validator": "^3.1.0",

packages/openapi-to-graphql/lib/oas_3_tools.js.map

@@ -522,7 +522,7 @@ export function getRequestBodyObject(
         oas
       ) as RequestBodyObject
     } else {
-      requestBodyObject = (requestBodyObject as any) as RequestBodyObject
+      requestBodyObject = requestBodyObject as RequestBodyObject
     }
 
     if (typeof requestBodyObject.content === 'object') {
@@ -534,6 +534,13 @@ export function getRequestBodyObject(
           payloadContentType: 'application/json',
           requestBodyObject
         }
+      } else if (
+        Object.keys(content).includes('application/x-www-form-urlencoded')
+      ) {
+        return {
+          payloadContentType: 'application/x-www-form-urlencoded',
+          requestBodyObject
+        }
       } else {
         // Pick first (random) content type
         const randomContentType = Object.keys(content)[0]
@@ -587,11 +594,16 @@ export function getRequestSchemaAndNames(
         : false
 
     /**
-     * Edge case: if request body content-type is not application/json, do not
-     * parse. Instead, treat the request body as a black box (allowing it to be
-     * defined as a string) and sending it with the appropriate content-type
+     * Edge case: if request body content-type is not application/json or
+     * application/x-www-form-urlencoded, do not parse it.
+     *
+     * Instead, treat the request body as a black box and send it as a string
+     * with the proper content-type header
      */
-    if (payloadContentType !== 'application/json') {
+    if (
+      payloadContentType !== 'application/json' &&
+      payloadContentType !== 'application/x-www-form-urlencoded'
+    ) {
       const saneContentTypeName = uncapitalize(
         payloadContentType.split('/').reduce((name, term) => {
           return name + capitalize(term)
@@ -602,7 +614,7 @@ export function getRequestSchemaAndNames(
         fromPath: saneContentTypeName
       }
 
-      let description = payloadContentType + ' request placeholder object'
+      let description = `String represents payload of content type '${payloadContentType}'`
 
       if (
         'description' in payloadSchema &&
@@ -651,7 +663,7 @@ export function getResponseObject(
           oas
         ) as ResponseObject
       } else {
-        responseObject = (responseObject as any) as ResponseObject
+        responseObject = responseObject as ResponseObject
       }
 
       if (
@@ -719,13 +731,12 @@ export function getResponseSchemaAndNames(
     }
 
     /**
-     * Edge case: if request body content-type is not application/json, do not
-     * parse. Instead, treat the request body as a black box (allowing it to be
-     * defined as a string) and sending it with the appropriate content-type
+     * Edge case: if response body content-type is not application/json, do not
+     * parse.
      */
     if (responseContentType !== 'application/json') {
       let description =
-        'Placeholder object to access non-application/json ' + 'response bodies'
+        'Placeholder to access non-application/json response bodies'
 
       if (
         'description' in responseSchema &&
@@ -748,10 +759,11 @@ export function getResponseSchemaAndNames(
     }
   } else {
     /**
-     * GraphQL requires that objects must have some properties. To allow some
-     * operations (such as those with a 204 HTTP code) to be included in the
-     * GraphQL interface, we added the fillEmptyResponses option, which will
-     * simply create a placeholder object with a placeholder property.
+     * GraphQL requires that objects must have some properties.
+     *
+     * To allow some operations (such as those with a 204 HTTP code) to be
+     * included in the GraphQL interface, we added the fillEmptyResponses
+     * option, which will simply create a placeholder to allow access.
      */
     if (options.fillEmptyResponses) {
       return {
@@ -761,7 +773,7 @@ export function getResponseSchemaAndNames(
         responseContentType: 'application/json',
         responseSchema: {
           description:
-            'Placeholder object to support operations with no response schema',
+            'Placeholder to support operations with no response schema',
           type: 'string'
         }
       }
@@ -841,7 +853,7 @@ export function getEndpointLinks(
       }
 
       // Here, we can be certain we have a ResponseObject:
-      response = (response as any) as ResponseObject
+      response = response as ResponseObject
 
       if (typeof response.links === 'object') {
         const epLinks: LinksObject = response.links
@@ -852,7 +864,7 @@ export function getEndpointLinks(
           if (typeof (link as ReferenceObject).$ref === 'string') {
             link = resolveRef(link['$ref'], oas)
           } else {
-            link = (link as any) as LinkObject
+            link = link as LinkObject
           }
           links[linkKey] = link
         }
@@ -892,7 +904,7 @@ export function getParameters(
         return resolveRef(p['$ref'], oas) as ParameterObject
       } else {
         // Here we know we have a parameter object:
-        return (p as any) as ParameterObject
+        return p as ParameterObject
       }
     })
     parameters = parameters.concat(pathItemParameters)
@@ -909,7 +921,7 @@ export function getParameters(
         return resolveRef(p['$ref'], oas) as ParameterObject
       } else {
         // Here we know we have a parameter object:
-        return (p as any) as ParameterObject
+        return p as ParameterObject
       }
     })
     parameters = parameters.concat(opParameters)
@@ -983,7 +995,7 @@ export function getSecuritySchemes(
         ) as SecuritySchemeObject
       } else {
         // We already have a SecuritySchemeObject:
-        securitySchemes[schemeKey] = (obj as any) as SecuritySchemeObject
+        securitySchemes[schemeKey] = obj as SecuritySchemeObject
       }
     }
   }

packages/openapi-to-graphql/lib/resolver_builder.js

@@ -8,8 +8,8 @@
  */
 
 // Type imports:
-import { Oas3, SchemaObject } from './types/oas3'
-import { Operation, DataDefinition } from './types/operation'
+import { SchemaObject } from './types/oas3'
+import { Operation } from './types/operation'
 import { ResolveFunction } from './types/graphql'
 import { PreprocessingData } from './types/preprocessing_data'
 import * as NodeRequest from 'request'
@@ -20,6 +20,7 @@ import * as querystring from 'querystring'
 import * as JSONPath from 'jsonpath-plus'
 import { debug } from 'debug'
 import { GraphQLError } from 'graphql'
+import formurlencoded from 'form-urlencoded'
 
 const translationLog = debug('translation')
 const httpLog = debug('http')
@@ -247,29 +248,29 @@ export function getResolver({
      * lookup here
      */
     resolveData.usedPayload = undefined
-    if (payloadName && typeof payloadName === 'string') {
+    if (typeof payloadName === 'string') {
       // The option genericPayloadArgName will change the payload name to "requestBody"
       const sanePayloadName = data.options.genericPayloadArgName
         ? 'requestBody'
         : Oas3Tools.sanitize(payloadName, Oas3Tools.CaseStyle.camelCase)
 
-      if (sanePayloadName in args) {
-        if (typeof args[sanePayloadName] === 'object') {
-          // We need to desanitize the payload so the API understands it:
-          const rawPayload = JSON.stringify(
-            Oas3Tools.desanitizeObjectKeys(args[sanePayloadName], data.saneMap)
-          )
-
-          options.body = rawPayload
-          resolveData.usedPayload = rawPayload
-        } else {
-          // Payload is not an object (stored as an application/json)
-          const rawPayload = args[sanePayloadName]
-
-          options.body = rawPayload
-          resolveData.usedPayload = rawPayload
-        }
+      let rawPayload
+      if (operation.payloadContentType === 'application/json') {
+        rawPayload = JSON.stringify(
+          Oas3Tools.desanitizeObjectKeys(args[sanePayloadName], data.saneMap)
+        )
+      } else if (
+        operation.payloadContentType === 'application/x-www-form-urlencoded'
+      ) {
+        rawPayload = formurlencoded(
+          Oas3Tools.desanitizeObjectKeys(args[sanePayloadName], data.saneMap)
+        )
+      } else {
+        // Payload is not an object
+        rawPayload = args[sanePayloadName]
       }
+      options.body = rawPayload
+      resolveData.usedPayload = rawPayload
     }
 
     /**

packages/openapi-to-graphql/lib/resolver_builder.js.map

@@ -13,7 +13,7 @@ import * as openAPIToGraphQL from '../lib/index'
 import { startServer, stopServer } from './example_api5_server'
 
 const oas = require('./fixtures/example_oas5.json')
-const PORT = 3005
+const PORT = 3007
 // Update PORT for this test case:
 oas.servers[0].variables.port.default = String(PORT)