Router about swagger-ui-express HOT 7 CLOSED

Make sure your endpoints are defined before the swagger-ui-express line, e.g.:

app.get('/test', function(req, res) { res.json({ status: 'OK'}); });
app.get('/bar', function(req, res) { res.json({ status: 'OKISH'}); });

app.use('/', swaggerUi.serve, swaggerUi.setup(swaggerDocument, false, options, '.swagger-ui .topbar { background-color: red }'));

Hope that helps.

from swagger-ui-express.

That helped. Now my endpoints are working but now when I request a non existing route, the swagger html is sent.

For example if I request localhost:3000/hdhdjsksk the swagger html is sent. What can I do?

from swagger-ui-express.

I tested this on the test app of this github and everything after main route is matched localhost:3000/api-docs/znxnxnsk

from swagger-ui-express.

You can place some middleware in to handle the matching as you require. Something like this would work:

const pageNotFound = (req, res, next) => {
	if (req.url !== '/') {
		res.send(404, 'Page not found');
	} else {
		next();
	}
}

app.use('/api-docs', swaggerUi.serve, pageNotFound, swaggerUi.setup(swaggerDocument, false, options, '.swagger-ui .topbar { background-color: red }'));

from swagger-ui-express.

Based on your idea I made some regex matches. This solves the problem but it feels like a hack to fix it like this. I still think that the problem relies on this package.

app.use((req, res, next) => {
  const match = req.url.match(/^\/v1\/.+/);
  const matchExtensions = req.url.match(/\.[a-z]{1,3}$/i);
  if (match !== null
      || req.url === '/'
      || matchExtensions !== null) {
    return next();
  }
  const err = new APIError('API not found', httpStatus.NOT_FOUND);
  return next(err);
});

from swagger-ui-express.

Possibly a better solution:

app.use('/api-docs', swaggerUi.serve)
app.get('/api-docs', swaggerUi.setup(swaggerDocument, false, options, '.swagger-ui .topbar { background-color: red }'));

from swagger-ui-express.

I found a better solution, but just for me now. Replaced this function in this line

return function(req, res, next) { 
      if (req.url === '/' ) {
        res.send(htmlWithFavIcon) 
      }
      else {
        next();
      }
    };

from swagger-ui-express.