[BUG] [typescript-angular] Base Path can't be set to '<empty string>'

[DanielHabenicht]

Bug Report Checklist

• Have you provided a full/minimal spec to reproduce the issue?
• Have you validated the input using an OpenAPI validator (example)?
• What's the version of OpenAPI Generator used?
• Have you search for related issues/PRs?
• What's the actual output vs expected output?
• [Optional] Bounty to sponsor the fix (example)

Description

If the basePath in the config is set to '' (empty string). The configuration is ignored and 'http://localhost' is used instead. That is unexpected behaviour.

Background

The basePath of the typescript-angular generated Files are currently set to 'http://localhost' (as a Fallback). When trying to setup the basePath to '' (empty String) the config is not used as the generated line of code configuration.basePath || basePath || this.basePath; is evaluated to false, because empty string in javascript is false.

  protected basePath = 'http://localhost';
  public configuration = new Configuration();

  constructor(
    protected httpClient: HttpClient,
    @Optional() @Inject(BASE_PATH) basePath: string,
    @Optional() configuration: Configuration
  ) {
    if (configuration) {
      this.configuration = configuration;
      this.configuration.basePath = configuration.basePath || basePath || this.basePath;
    } else {
      this.configuration.basePath = basePath || this.basePath;
    }
  }

openapi-generator version

4.0.0-beta2

OpenAPI declaration file content or url

Command line used for generation

npm install @openapitools/openapi-generator-cli@0.0.8-4.0.0-beta2
openapi-generator generate -i swagger.json -g typescript-angular -o projects/client-api/src/lib/ --additional-properties="ngVersion=6.1.7" --additional-properties="supportsES6=true"

Steps to reproduce

1. Generate typescript-angular package from openapi.config
2. Configure the ApiModule in app.module.ts
3. Use a service from the generated typescript-angular package.

Related issues/PRs

Nothing found.

Suggest a fix

Two ways:

1. Remove the fallback basePath by setting it to '' (empty string)
2. Fix the evalutation basePath property.

[auto-labeler]

👍 Thanks for opening this issue!
🏷 I have applied any labels matching special text in your issue.

The team will review the labels and make any necessary changes.

[macjohnny]

@DanielHabenicht would you like to implement a fix for this?

[DanielHabenicht]

If you can tell me where the basePath is set I would be more than happy to provide a PR. :)
I've ready searched for it but could not find the code.

[macjohnny]

openapi-generator/modules/openapi-generator/src/main/resources/typescript-angular/api.service.mustache

Lines 59 to 71 in baf0e85

	protected basePath = '{{{basePath}}}';
	public defaultHeaders = new {{#useHttpClient}}Http{{/useHttpClient}}Headers();
	public configuration = new Configuration();
	constructor(protected {{#useHttpClient}}httpClient: HttpClient{{/useHttpClient}}{{^useHttpClient}}http: Http{{/useHttpClient}}, @Optional()@Inject(BASE_PATH) basePath: string, @Optional() configuration: Configuration) {
	if (configuration) {
	this.configuration = configuration;
	this.configuration.basePath = configuration.basePath || basePath || this.basePath;
	} else {
	this.configuration.basePath = basePath || this.basePath;
	}

[macjohnny]

But you can set the basepath in your .yaml file

[nyszilard]

It doesn't work for me...

@Bean
public OpenAPI openAPI() {
    OpenAPI openAPI = new OpenAPI().info(
        new Info()
            .title("API")
            .description("API description")
            .version("1.0.0")
    );
    Server server = new Server();
    server.setUrl("");
    openAPI.setServers(List.of(server));
    return openAPI;
}

Output:

protected basePath = 'http://localhost';

[bartbergmans]

For our project where we use the latest version of the openapi-generator it still defaults the basePath as http://localhost. Any idea if this problem is back or if we are using it wrong?

[NetzwergX]

Neither the empty string nor a relative URL like / currently work. This makes it extremely hard to use the generator for portable code. We have at least two different projects where we'd like to set the base path to /. It appears that way in our YAML file, and the generator should not simply ignore that.

Please redirect effort towards this issue, it has been open long enough. We are currently patching the generated source files, which is a really, really dirty practice.

[macjohnny]

@NetzwergX happy to accept your PR

[martinnovak]

@NetzwergX what do you mean by having the base path as relative url, but setting it as /?

I use OpenAPI this way - I define API endpoint as /api/users and then I set the base url as empty string.

[hieucd04]

I'm running into this issue today too.

• I tried to set basePath to both '' (empty string) and / and none of them work.
• I also tried to set server to both '' (empty string) and / and none of them work.

My use case is simple: I just want to send HTTP requests to whatever appears in browser address bar without using window.location.href (window is not even available in my case as I'm doing React SSR)

My current workaround is to modify the typescript-axios template files which is OK for now but will become an overhead in the long run as I will have to keep updating the template to keep it in sync with its online version.

Can this issue be reopened so that I can subscribe to it and be notified when it's closed?

[macjohnny]

@hieucd04 you can open a new issue and provide a fix for it

[kerren]

For anyone that's arriving here from search, I've been able to set the basePath variable in Angular using basePath=<YOUR_PATH> in the additional-properties flag in the CLI generate command. An example would be:

npx --yes @openapitools/openapi-generator-cli \
	generate -i ./src/openapi.yaml \
	-g typescript-angular \
	-o ./src/generated-client \
	--additional-properties=fileNaming=kebab-case,basePath=''

You'll now see in your Angular classes the following:

	protected basePath = '';