Swagger Node with custom UI document path

[linchun huang]

Hello,

I am using swagger node to build my REST server, it seems by default the swagger UI web page will be displayed 

under the url of  /docs.

Instead of configuring the root path, is there any way to change this path to any value? (For example /myrest/v1/api-docs)

Thank you!

[tony tam]

Looks like the UI is loaded via the swagger-tools dependency, which has a configuration for the location of the route.  I’d suggest looking in there

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[linchun huang]

Thanks Tony! I have found the way to configure swagger-ui middleware here !

 

[tony tam]

Great—do you mind sharing the full solution so others can see?

On May 23, 2016, at 12:50 AM, linchun huang <vcsh...@gmail.com> wrote:

Thanks Tony! I have found the way to configure swagger-ui middleware here !

 

[linchun huang]

If you are using Swagger2.0, you can pass options as the second parameter into the constructor of the swagger-ui middleware.

For now the swagger-ui and api-doc are the two options that I am concerned about, other options can be referenced here!

var SwaggerExpress = require('swagger-express-mw');
var SwaggerUi = require('swagger-tools/middleware/swagger-ui');
var app = require('express')();

 ...

SwaggerExpress.create(config, function(err, swaggerExpress) {
  
  var option = {

    swaggerUi:"/any_path_you_want",//swagger ui web page
    apiDocs:"/any_path_you_want"//api document in json format
  };

  app.use(SwaggerUi(swaggerExpress.runner.swagger, option));

  // install middleware
  swaggerExpress.register(app);

 ...

});

Hope this help!