vitepress-openapi/src/lib/codeSamples/buildHarRequest.ts

Generate VitePress API Documentation from OpenAPI Specification.

import type { HarRequest } from '@scalar/snippetz'
import type { OARequest } from './request'
import { isFormUrlEncoded, isMultipartFormData } from '../utils/contentTypeUtils'

export function buildHarRequest(
  oaRequest: OARequest,
): HarRequest {
  const harRequest: HarRequest = {
    method: oaRequest.method.toUpperCase(),
    url: decodeURI(oaRequest.url.toString()),
    httpVersion: 'HTTP/1.1',
    headers: Object.entries(oaRequest.headers).map(([name, value]) => ({
      name: name.replace(/\b\w/g, letter => letter.toUpperCase()), // Convert to title case.
      value,
    })),
    queryString: [
      ...Object.entries(oaRequest.query).flatMap(([name, value]) => {
        if (Array.isArray(value)) {
          // Exploded arrays: create multiple entries with same name
          return value.map(v => ({ name, value: String(v) }))
        }
        return [{ name, value: typeof value === 'object' ? JSON.stringify(value) : String(value) }]
      }),
    ],
    cookies: Object.entries(oaRequest.cookies).map(([name, value]) => ({
      name,
      value,
    })),
    headersSize: -1,
    bodySize: -1,
  }

  if (oaRequest.body !== undefined) {
    if (typeof oaRequest.body === 'string') {
      harRequest.postData = {
        mimeType: oaRequest.contentType || 'application/json',
        text: oaRequest.body,
      }
    } else if (oaRequest.body instanceof FormData) {
      const formDataObject: Record<string, any> = {}

      oaRequest.body.forEach((value, key) => {
        if (value instanceof File) {
          formDataObject[key] = {
            type: 'file',
            text: 'BINARY',
            name: value.name,
            size: value.size,
            mimeType: value.type || 'application/octet-stream',
          }
        } else {
          const values = oaRequest.body.getAll(key)
          if (values.length > 1) {
            formDataObject[key] = values
          } else {
            formDataObject[key] = values[0]
          }
        }
      })

      harRequest.postData = {
        mimeType: oaRequest.contentType || 'multipart/form-data',
        params: Object.entries(formDataObject).map(([name, value]) => {
          if (typeof value === 'object' && value !== null && 'text' in value) {
            return {
              name,
              value: value.text,
              fileName: value.name,
              contentType: value.mimeType,
            }
          } else {
            return {
              name,
              value: String(value),
            }
          }
        }),
      }
    } else if (typeof oaRequest.body === 'object') {
      if (oaRequest.contentType && (isFormUrlEncoded(oaRequest.contentType) || isMultipartFormData(oaRequest.contentType))) {
        harRequest.postData = {
          mimeType: oaRequest.contentType,
          params: Object.entries(oaRequest.body).map(([name, value]) => {
            return {
              name,
              value: String(value),
            }
          }),
        }
      } else {
        // Default to JSON for other content types.
        harRequest.postData = {
          mimeType: oaRequest.contentType || 'application/json',
          text: JSON.stringify(oaRequest.body),
        }
      }
    }
  }

  return harRequest
}