/api-docs redirects to Swagger demo Pet Store when to portal is run in production environment

[tschaffter]

[tschaffter]

Swagger is looking at the following files for the documentation:

    var swaggerJSDocOptions = {
        swaggerDefinition: swaggerDefinition,
        apis: [
            './**/api/**/index.js',
            './**/auth/**/*.js',
            './shared/interfaces/**/*.ts'
            // './**/swagger/**/*.ts'
        ]
    };

However these source files are not present in the production build. This is likely the issue, yet it is strange that Swagger decide by itself to show the Pet store demo if no documentation is passed instead of throwing an error.

A solution would compile the source files with the Swagger doc into a single file during npm run build, then make sure that Swagger looks for this output file in production mode. Moreover, we need to copy this file to the production docker image.

[tschaffter]

Notes

The idea is to keep the current setup in development environment. This way we benefit from the hot reloading of the dev server.

In production environment, I'll add a webpack task to compile swagger.json from the source files, then have the backend serve this file in production environment.

Part of this fix has already been implemented in #555, but as this PR is not going to be merged in Milestone 2, I'll extract part of it to fix this swagger issue right now.

[tschaffter]

An issue was due to an update of swagger-ui-express. I implemented the solution describe here: scottie1984/swagger-ui-express#94

Thus I replaced:

app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument, swaggerOptions));

by

    const swaggerSetup = swaggerUi.setup(swaggerDocument, swaggerOptions);
    app.get('/api-docs/index.html', swaggerSetup);
    app.use('/api-docs', swaggerUi.serve);
    app.get('/api-docs', swaggerSetup);

Aside the source of the swagger definitions, I'm not sure why this issue hit only the production environment. Maybe the way the server and the client dev server serve routes.

[tschaffter]

The fix is provided in the above PR.