Is it possible to setup multiple clients under a single config?

[costa-collibra]

import { defineConfig } from '@hey-api/openapi-ts';

export default defineConfig({
  input: 'path/to/openapi.json',
  output: 'src/client',
});

In my codebase we are using around 6 schema files to generate multiple clients.

Is there a way you recommend doing this using a single config file?

Thanks

[jordanshatford]

@costa-collibra no there is not a current way of doing this. Would need separate configs for each. You could create a file containing common configuration options and import it each (spreading it in the defineConfig)

[costa-collibra]

Manage to solve it a better way

import { createClient } from '@hey-api/openapi-ts';

createClient({
  input: 'path/to/openapi.json',
  output: 'src/client',
});

then i create an array of my various configs and create them in a promise all, spreading the default common config, its really nice

[costa-collibra]

full example

const defaultConfig = {
  client: 'axios',
  lint: false,
  format: false,
};

const config = [
  {
    name: 'UsageAnalyticsAppUsageClient',
    input: './resources/usage-analytics/usage_1.0.yaml',
    output: './generated/usage-analytics-client/usage',
  },
  {
    name: 'UsageAnalyticsAppUsersClient',
    input: './resources/usage-analytics/users_1.0.yaml',
    output: './generated/usage-analytics-client/users',
  },
  {
    name: 'UsageAnalyticsAppEventsClient',
    input: './resources/usage-analytics/events_1.0.yaml',
    output: './generated/usage-analytics-client/events',
  },
  {
    name: 'ImportAppClient',
    input: './resources/dgc-importer-rest.json',
    output: './generated/dgc-import-client',
  },
  {
    name: 'CoreAppClient',
    input: './resources/dgc-rest.json',
    output: './generated/core-client',
  },
  {
    name: 'CorePrivateAppClient',
    input: './resources/dgc-private-rest.json',
    output: './generated/core-private-client',
  },
  {
    name: 'EdgeAppClient',
    input: './resources/edge-management-api.yaml',
    output: './generated/edge-client',
  },
  {
    name: 'CloudIngestionsAppClient',
    input: './resources/cloud-ingestions-rest.json',
    output: './generated/cloud-ingestions-client',
  },
  {
    name: 'DataClassApiClient',
    input: './resources/data-class-api.yaml',
    output: './generated/data-class-client',
  },
  {
    name: 'DataClassificationAppClient',
    input: './resources/data-classification-rest.json',
    output: './generated/data-classification-client',
  },
  {
    name: 'ProtectApiClient',
    input: './resources/protect-public-api.yaml',
    output: './generated/protect-client',
  },
].map((c) => ({ ...defaultConfig, ...c }));

async function generateAll() {
  const openApiTs = await import('@hey-api/openapi-ts');

  for (const c of config) {
    await openApiTs.createClient(c);
  }
}

generateAll()
  .then(() => console.log('Finished generating'))
  .catch(console.error);

[mrlubos]

Are you happy with this approach? Sorry I'm late to this conversation, just wondering if this is still an open question

[costa-collibra]

I’m more than happy with this approach 😊

[jordanshatford]

@costa-collibra thanks for providing an example of your solution. Just out of curiosity. What is something we could do that could help your project? For example, projects like vitest provide defineWorkspace. Maybe that is something we could do aswell.

Cc: @mrlubos

[costa-collibra]

That sounds really cool yes. For more context we use this library to generate all our clients in our e2e repository that is used across 18 teams in the the business. We use Playwright, and the codegen is a really important component as we need the apis to create all our data setup.

This is why we have so many clients.

A workspace sounds like a great fit for us as we could basically say here is a list of schemas that we need and then it can go away build the clients

[nikstuckenbrock]

Hey guys,

why not use an array of configurations for the defineConfig method? Or create a defineConfigs method?

[mrlubos]

@nikstuckenbrock #564

[nikstuckenbrock]

Hey @mrlubos ,

thanks for the ref, but in my case this doesn't help. I have eight completely different apis which I want to generate clients for.