Add swagger

Author: hirsch88

.env.example

@@ -14,6 +14,13 @@ DEBUG=app*,api*,core*
 LOG_LEVEL=debug
 LOG_ADAPTER=debug
 
+#
+# Swagger Documentation
+#
+SWAGGER_ENABLED=true
+SWAGGER_ROUTE=/docs
+SWAGGER_FILE='./swagger.json'
+
 #
 # DATABASE
 #

package.json

@@ -104,6 +104,7 @@
     "require-dir": "^0.3.1",
     "run-sequence": "^1.2.2",
     "serve-favicon": "^2.4.3",
+    "swagger-ui-express": "^2.0.0",
     "ts-jest": "^20.0.4",
     "ts-node": "^3.0.4",
     "tslint": "^5.2.0",

src/api/controllers/UserController.ts

@@ -28,6 +28,13 @@ export class UserController {
         return res.found(users.toJSON());
     }
 
+    @Post('/')
+    public async create( @Response() res: my.Response, @RequestBody() body: any): Promise<any> {
+        log.debug('create ', body);
+        const user = await this.userService.create(body);
+        return res.created(user.toJSON());
+    }
+
     @Get('/me', populateUser)
     public async findMe( @Request() req: my.Request, @Response() res: my.Response): Promise<any> {
         log.debug('findMe');
@@ -41,13 +48,6 @@ export class UserController {
         return res.found(user.toJSON());
     }
 
-    @Post('/')
-    public async create( @Response() res: my.Response, @RequestBody() body: any): Promise<any> {
-        log.debug('create ', body);
-        const user = await this.userService.create(body);
-        return res.created(user.toJSON());
-    }
-
     @Put('/:id')
     public async update( @Response() res: my.Response, @RequestParam('id') id: string, @RequestBody() body: any): Promise<any> {
         log.debug('update ', body);

src/api/requests/UserCreateRequest.ts

@@ -24,7 +24,6 @@ export class UserCreateRequest extends RequestBody {
 
     picture: string;
 
-    @IsNotEmpty()
     auth0UserId: string;
 
 }

src/api/requests/UserUpdateRequest.ts

@@ -27,7 +27,6 @@ export class UserUpdateRequest extends RequestBody {
 
     picture: string;
 
-    @IsNotEmpty()
     auth0UserId: string;
 
     setFirstName(value: string): void {

src/core/Bootstrap.ts

@@ -28,8 +28,6 @@ export class Bootstrap {
      */
     static getApp(): express.Application {
         const app = express();
-
-        // Set serve configs for running it
         app.set('host', Environment.get('APP_HOST'));
         app.set('port', Bootstrap.normalizePort(Environment.get<string>('PORT') || Environment.get<string>('APP_PORT')));
         log.debug('app is defined');
@@ -48,11 +46,47 @@ export class Bootstrap {
      * @memberof Bootstrap
      */
     static build(app: express.Application, container: Container): express.Application {
+        app = Bootstrap.setupSwagger(app);
         let server = new InversifyExpressServer(container, undefined, { rootPath: Environment.get<string>('APP_URL_PREFIX') }, app);
         log.debug('ioc is bonded');
+        server = Bootstrap.setupConfigurations(server);
+        return server.build();
+    }
+
+    /**
+     * Sets up the express middlewares witch are last in the chain
+     *
+     * @static
+     * @param {InversifyExpressServer} server
+     * @returns {InversifyExpressServer}
+     *
+     * @memberof Bootstrap
+     */
+    static setupConfigurations(server: InversifyExpressServer): InversifyExpressServer {
         server.setConfig((a) => a.use(extendExpressResponse));
         server.setErrorConfig((a) => a.use(exceptionHandler));
-        return server.build();
+        return server;
+    }
+
+    /**
+     * Sets up the swagger documentation
+     *
+     * @static
+     * @param {express.Application} app
+     * @returns {express.Application}
+     *
+     * @memberof Bootstrap
+     */
+    static setupSwagger(app: express.Application): express.Application {
+        if (Environment.get<string>('SWAGGER_ENABLED') === 'true') {
+            const basePath = __dirname.substring(0, __dirname.indexOf('/src/') + 4);
+            const swaggerUi = require('swagger-ui-express');
+            const swaggerDocument = require(basePath + Environment.get<string>('SWAGGER_FILE'));
+            const route = Environment.get<string>('APP_URL_PREFIX') + Environment.get<string>('SWAGGER_ROUTE');
+            app.use(route, swaggerUi.serve, swaggerUi.setup(swaggerDocument));
+            log.info(`Now you can access the swagger docs under -> ${app.get('host')}:${(app.get('port'))}${route}`);
+        }
+        return app;
     }
 
     /**

src/core/Server.ts

@@ -39,7 +39,7 @@ export class Server {
      * @memberof Server
      */
     static onStartUp(app: express.Application): void {
-        log.info(`started on ${app.get('host')}:${app.get('port')}`);
+        log.info(`Aloha, your app is ready on ${app.get('host')}:${app.get('port')}`);
     }
 
     /**

src/core/api/extendExpressResponse.ts

@@ -44,11 +44,11 @@ export const extendExpressResponse = (req: my.Request, res: my.Response, next: e
     };
 
     /**
-     * 204 - Destroyed
+     * 200 - Destroyed
      * This is the response after a resource has been removed
      */
     res.destroyed = (options: my.ResponseOptions = {}) => {
-        res.status(204);
+        res.status(200);
         return res.json(bodySuccessful(null));
     };