既存プロジェクトに後からopenapiを追加してAxiosのリクエストをJestでテストしたい

const axios = Axios.create()

axios.interceptors.request.use(async (config: AxiosRequestConfig) => {
  // リクエスト直前のここでOpenAPIの定義通りのリクエストになっているかを判定する
})

import swaggerParser from '@apidevtools/swagger-parser'
import OpenAPIRequestValidator from 'openapi-request-validator'

const testRequset = {
  headers: {
    Authorization: `token xxxxxxxxxxxxxxxxxxxxxx`,
    'content-type': 'application/json',
  },
  body: {
    hoge: 'huga',
  },
  params: {
    foo: 'bar',
  },
}

const OPEN_API_FILE_PATH = '/path/to/openapi.yml'

const openapi = await swaggerParser.parse(OPEN_API_FILE_PATH)

// 今回リクエストする定義を取り出す
const requestUrl = '/api/sample'
const requestMethod = 'get'
const requestBodyDefinition = openapi.paths[requestUrl][requestMethod].requestBody

// 取り出した定義でvalidatorを作る
const validator = new OpenAPIRequestValidator({ requestBody: requestBodyDefinition })

// リクエストが定義に一致するか確認する
const error = validator.validateRequest(testRequset)

if (error === undefined) {
  // 定義通りで問題がない時
} else {
  // 定義とは異なるリクエストを送ろうとしている時
}

import axios, { AxiosRequestConfig } from 'axios'
import swaggerParser from '@apidevtools/swagger-parser'
import OpenAPIRequestValidator from 'openapi-request-validator'

async function createAxiosInstanceWithRequestValidator() {
  const OPEN_API_FILE_PATH = '/path/to/openapi.yml'
  const openapi = await swaggerParser.parse(OPEN_API_FILE_PATH)

  const axios = Axios.create()

  axios.interceptors.request.use(async (config: AxiosRequestConfig) => {
    const requestBodyDefinition = openapi.paths[config.url][config.method].requestBody

    const validator = new OpenAPIRequestValidator({ requestBody: requestBodyDefinition })

    const error = validator.validateRequest(testRequset)

    let signal = {}
    if (error === undefined) {
      signal = { isValid: true, errors: [] }
    } else {
      signal = { isValid: false, errors: error.errors }
    }
    throw signal
  })

  return axios
}

async function validationHelper(handler: Promise<unkown>): Promise<Boolean> {
  // リクエストのバリデーション結果は大域脱出でthrowされてくるのでキャッチする
  try {
    await handler
  } catch (signal) {
    if (signal instanceof Error) {
      // 通常のエラーであれば再度エラーを投げ直す
      throw signal
    }
    const validateRequestResult = signal as { isValid: boolean; errors?: any }

    if (validateRequestResult.isValid === false) {
      throw Error('リクエストがOpenAPIの定義通りではありません')
    }

    // リクエストが定義通りに行われた場合はTrueを返す
    return true
  }
}

describe('リクエストが定義通りかどうかのテスト', () => {
  test('/hogeへのgetリクエストはOpenAPIの定義通りである', async () => {
    const axios = await createAxiosInstanceWithRequestValidator()

    const requestHandler = axios.get('/hoge', { a: 'A' })

    await expect(validationHelper(requestHandler)).resolved.toBe(true)
  })
})