Swagger-codegen: JS client has hard-coded service URL

[delenius]

My swagger spec has something like

basePath: "/foo/bar"

Based on this, the JS client generator produces this code in ApiClient.js

this.basePath = 'http://localhost/foo/bar'.replace(/\/+$/, '');

It would be much nicer if the service URL was not hard-coded into the generated client code, especially since it happens to be wrong in this case: My service also needs a port number. I don't think the server URL is normally part of the swagger spec. And for good reason: During the lifecycle of a service, it may run in different places (for development/testing/production, etc).

Note that swagger-js allows you to pass the URL as a parameter:

var Swagger = require('swagger-client');

var client = new Swagger({
  url: 'http://petstore.swagger.io/v2/swagger.json',
  success: function() {
    client.pet.getPetById({petId:7},{responseContentType: 'application/json'},function(pet){
      console.log('pet', pet);
    });
  }
});

[delenius]

Oh, I see now that the spec allows for a separate "host" field. Still, it would be nice to be able to pass this at runtime. Currently, since I am generating my swagger spec from the Java server code, the Java source code has to know where the service will be deployed. Not good separation of concerns.

[delenius]

To be more precise, the ApiClient constructor could take the host as an optional argument, which would then override the default.

[fehguy]

I'm not trying to complicate things, but there are some other options with javascript. Have you seen the swagger-js project? All these things are covered there.

[delenius]

Yes, that's why I pointed to that project above :)

But I much prefer to generate the client statically. It has many advantages:

• Much less overhead at runtime (time to generate client, network transfer for large codegen library and large swagger file, etc).
• The statically generated client can be minified and uglified.
• The statically generated client can be used to produce client documentation (with JSDoc or the like).

It just doesn't make much sense to me to generate the client at runtime.

[fehguy]

no problem at all :) and now I see that you obviously knew about it

[xhh]

The basePath field of ApiClient has a default value and could be overridden. For example:

ApiClient.default.basePath = 'http://example.com/v2';
var petApi = new PetApi(); // using ApiClient.default if no argument is provided

var devClient = new ApiClient();
devClient.basePath = 'http://localhost:8080';
var devPetApi = new PetApi(devClient);

[delenius]

@xhh, ok, but that still combines the host and basePath into one. In swagger, these are two different properties, "host" and "basePath".

I'd like to only change the host part, and be able to use the basePath from the swagger spec.

[wing328]

@delenius we prefer combining host and basePath into one as API clients in other languages behave the same and we're trying deliver a consistent developer experience across different langauges.

[delenius]

@wing328 ok, then I will use the method above to set the whole thing.

[wing328]

@delenius thanks. Please let us know if you've further feedback. Btw, we just merged #2030 and you may want to pull the latest master to generate the Javascript API client again.

[delenius]

Will do, thanks! :+1:

[hc-romens]

@delenius, Any progress on this issue?

[delenius]

@hc-romens, this was closed a long time ago. See above for a workaround (which I use).

[hc-romens]

@delenius somehow, swagger-js is not the solution I want. Cause, the endpoint APIs defined in swagger.json are allowed to be published and public.

I am reading the source code, and try to make a patch for the statis generated js client code to take the host as the module param. So that the host value can be passed in as the command line option.

Anyway, thanks a lot!