Saving API url inside a variable

[gabimoncha]

Hi, I really love orval and we've started using it a lot in our monorepo codebase, even including it in our CI/CD.
I'm wondering if it's possible to also save the URLs inside a variable?

We've created some endpoints that are passed to some integrated SDKs and in case these change in the future, it would be nice to have orval update the variables instead of having to update the enpoints manually :)

[anymaniax]

Hello @gabimoncha, You can accomplish that with a mutator

[gabimoncha]

Hi, I'm not referring to the base url. I'm talking about the endpoint's route

[jamalsoueidan]

Did you figure it out? I also need the endpoint route in a variable!

export const authReceivePassword = (
  authPasswordRequest: AuthPasswordRequest,
  options?: AxiosRequestConfig
): Promise<AxiosResponse<AuthPasswordResponse>> => {
  return axios.post(`/auth/receive-password`, authPasswordRequest, options);
};

Like this.

const authReceivePasswordUrl = `/auth/receive-password`

[NimmLor]

Hi, you could modify the output with the afterAllFilesWrite write hook.

import fs from 'fs'
import { defineConfig } from 'orval'


/**
 * This function is called after all files are written.
 * It replaces all API endpoint URLs with variables, and exports those variables.
 *
 * @param {string[]} files - The list of files that were written.
 */
const afterAllFilesWrite = (files: string[]) => {
  // This is a mapping of variable names to their endpoint URLs.
  const variables = {
    ordersEndpointUrl: '`/orders`',
    productsEndpointUrl: '`/products`',
  }

  for (const file of files) {
    // Read the file's content.
    let content = fs.readFileSync(file, 'utf8')

    for (const [variableName, endpoint] of Object.entries(variables)) {
      // Check if the file's content includes the endpoint URL.
      if (content.includes(endpoint)) {
        // Replace the endpoint URL with the variable name.
        content = content.replaceAll(endpoint, variableName)
        // Add the variable to the end of the file.
        content += `\nexport const ${variableName} = ${endpoint};\n`
      }
    }

    fs.writeFileSync(file, content)
  }
}



export default defineConfig({
  sampleApi: {
    hooks: { afterAllFilesWrite },
    // ...
  }
})

[jamalsoueidan]

Thank you, I will try this and see if it works :)

[anymaniax]

Could also be a feature added to the generated code but we need to see if it's useful for a lot of people