search

OpenAPITools / openapi-generator

OpenAPI Generator allows generation of API client libraries (SDK generation), server stubs, documentation and configuration automatically given an OpenAPI Spec (v2, v3)
https://openapi-generator.tech
Apache License 2.0
21.51k stars 6.51k forks source link

[BUG][typescript-axios] index.ts: Module "./api" has already exported a member named 'Configuration' #11717

Open scscgit opened 2 years ago

scscgit commented 2 years ago

Bug Report Checklist

Description

In the generated index.ts for typescript-axios, there is always the following content:

export * from "./api";
export * from "./configuration";

When our API includes an interface named Configuration in api.ts, it conflicts with the export of Configuration in configuration.ts. This causes the second line to report error TS2308: Module "./api" has already exported a member named 'Configuration'. Consider explicitly re-exporting to resolve the ambiguity.. There is no way to directly resolve the issue without manually editing the files after each code generation, or without hard-coding custom scripts.

Same applies to api.ts where import { Configuration } from './configuration'; causes error Import declaration conflicts with local declaration of 'Configuration'. ts(2440). Here it also causes conflicts in the code, so we aren't able to just find-and-replace.

openapi-generator version

5.4.0

OpenAPI declaration file content or url

Any yaml with Configuration type, for example having:

    Configuration:
      required:
        - name
        - type
        - value
      type: object
      properties:
        type:
          type: string
        name:
          type: string
        value:
          type: object

under

components:
  schemas:

along with all references: $ref: '#/components/schemas/Configuration'

Generation Details

npx @openapitools/openapi-generator-cli generate -i schemas/configurationapi.yaml -g typescript-axios -o generated/configurationapi --type-mappings DateTime=Date

Steps to reproduce

Perform the generation and build any TypeScript project (for example using Nuxt/Vue template npx create-nuxt-app <project-name>)

Related issues/PRs

No results when searching for the error message.

Suggest a fix
fetis commented 2 years ago

still an issue with version 6.0

hiddenist commented 1 year ago

Related: having a parameter named configuration in your api spec generates a conflicting shadowed parameter (as tested in typescript)

{
  "openapi": "3.0.1",
  "info": {
    "title": "ConfigurationBugRepro",
    "version": "v1"
  },
  "paths": {
    "/update-configuration": {
      "post": {
        "operationId": "UpdateConfiguration",
        "parameters": [
          {
            "name": "configuration",
            "in": "query",
            "schema": {
              "type": "string"
            }
          }
        ]
      }
    }
  }
}
/**
 * DefaultApi - functional programming interface
 * @export
 */
export const DefaultApiFp = function(configuration?: Configuration) {
    //                               ^^^^^^^^^^^^^
    const localVarAxiosParamCreator = DefaultApiAxiosParamCreator(configuration)
    return {
        /**
         * 
         * @param {string} [configuration] 
         * @param {*} [options] Override http request option.
         * @throws {RequiredError}
         */
        async updateConfiguration(configuration?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
            //                    ^^^^^^^^^^^^^
            const localVarAxiosArgs = await localVarAxiosParamCreator.updateConfiguration(configuration, options);
            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
            //                                                                      ^^^^^^^^^^^^^
            //                     Passing in a string, but supposed to be of type "Configuration"
        },
    }
};
rruzicka-inno commented 4 months ago

Hi are there any updates on this issue? We are having the same problem and there just isn't a nice fix for this, except for manually changing the Configuration type in the generated file, which is not something we would like to do 😕

majid-rafei commented 1 month ago

As a workaround: There are CLI additional properties "withInterfaces" and "prefixParameterInterfaces" that when are set to true, the interfaces of a service are generated in a separate file with the (service) class name as a prefix of interfaces, hence no conflict with interfaces with the same name in other services! please have a look at this mustache file: