Merge branch 'release/1.5.2'

Author: hirsch88

.env.example

@@ -19,7 +19,7 @@ LOG_ADAPTER=debug
 #
 SWAGGER_ENABLED=true
 SWAGGER_ROUTE=/docs
-SWAGGER_FILE='./swagger.json'
+SWAGGER_FILE=/src/api/swagger.json
 
 #
 # DATABASE

README.md

@@ -11,7 +11,7 @@ A delightful way to building a RESTful API with NodeJs & TypeScript.
 - **Easy Data Seeding** with our own factories.
 - **Custom Commands** are also available in our setup and really easy to use.
 - **Smart Validation** thanks to [class-validator](https://github.com/pleerock/class-validator) with some nice annotations.
-- **Inline Swagger Documentation** thanks to [swagger-jsdoc](https://github.com/Surnet/swagger-jsdoc)
+- **API Documentation** thanks to [swagger](http://swagger.io/).
 
 ## Getting Started
 ### Prerequisites
@@ -83,6 +83,7 @@ The port will be displayed to you as `http://0.0.0.0:3000` (or if you prefer IPv
 * [class-validator](https://github.com/pleerock/class-validator)
 * [Jest](http://facebook.github.io/jest/)
 * [Auth0 API Documentation](https://auth0.com/docs/api/management/v2#!/Users/get_users)
+* [swagger Documentation](http://swagger.io/)
 
 ## License
  [MIT](/LICENSE)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "express-typescript-boilerplate",
-  "version": "1.5.1",
+  "version": "1.5.2",
   "description": "A delightful way to building a RESTful API with NodeJs & TypeScript",
   "main": "src/index.ts",
   "scripts": {
@@ -17,7 +17,7 @@
     "db:seed": "./node_modules/.bin/knex seed:run",
     "db:reset": "npm run console db:reset",
     "console": "./node_modules/.bin/ts-node ./src/console/commander.ts",
-    "serve": "./node_modules/.bin/nodemon --watch 'src/**/*.ts'",
+    "serve": "./node_modules/.bin/nodemon --watch 'src/**/*.ts' --watch 'src/**/*.json'",
     "start": "node src/index.js"
   },
   "repository": "git+ssh://git@github.com/w3tec/express-typescript-boilerplate.git",

src/api/controllers/HomeController.ts

@@ -10,18 +10,6 @@ import { injectable } from 'inversify';
 @Controller('/v1')
 export class HomeController {
 
-    /**
-     * @swagger
-     * /:
-     *   get:
-     *     tags:
-     *     - Root
-     *     summary: Show API information
-     *     description: Gets the api information
-     *     responses:
-     *       200:
-     *         description: api information
-     */
     @Get('/')
     public get( @Response() res: express.Response): any {
         const pkg = require('../../../package.json');

src/api/controllers/UserController.ts

@@ -18,216 +18,40 @@ export class UserController {
 
     constructor( @inject(Types.UserService) private userService: UserService) { }
 
-    /**
-     * @swagger
-     * /user:
-     *   get:
-     *     tags:
-     *     - User
-     *     summary: List all users
-     *     description: Returns users
-     *     security:
-     *     - JWT: []
-     *     responses:
-     *       200:
-     *         description: List of all users
-     *         schema:
-     *           type: object
-     *           title: UserResponse
-     *           properties:
-     *             success:
-     *               type: boolean
-     *             message:
-     *               type: string
-     *             data:
-     *               type: array
-     *               items:
-     *                 $ref: "#/definitions/User"
-     */
     @Get('/')
     public async findAll( @Response() res: my.Response): Promise<any> {
         log.debug('findAll');
         const users = await this.userService.findAll();
         return res.found(users.toJSON());
     }
 
-    /**
-     * @swagger
-     * /user:
-     *   post:
-     *     tags:
-     *     - User
-     *     summary: Create new user
-     *     description: Creates new user and returns him
-     *     security:
-     *     - JWT: []
-     *     parameters:
-     *     - in: "body"
-     *       name: "body"
-     *       required: true
-     *       schema:
-     *         $ref: "#/definitions/NewUser"
-     *     responses:
-     *       200:
-     *         description: New user
-     *         schema:
-     *           type: object
-     *           title: UserResponse
-     *           properties:
-     *             success:
-     *               type: boolean
-     *             message:
-     *               type: string
-     *             data:
-     *               $ref: "#/definitions/User"
-     */
     @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());
     }
 
-    /**
-     * @swagger
-     * /user/me:
-     *   get:
-     *     tags:
-     *     - User
-     *     summary: Get logged in user
-     *     description: Returns logged in user
-     *     security:
-     *     - JWT: []
-     *     responses:
-     *       200:
-     *         description: User
-     *         schema:
-     *           type: object
-     *           title: UserResponse
-     *           properties:
-     *             success:
-     *               type: boolean
-     *             message:
-     *               type: string
-     *             data:
-     *               type: object
-     *               $ref: "#/definitions/User"
-     */
     @Get('/me', populateUser)
     public async findMe( @Request() req: my.Request, @Response() res: my.Response): Promise<any> {
         log.debug('findMe');
         return res.found(req.user);
     }
 
-    /**
-     * @swagger
-     * /user/{id}:
-     *   get:
-     *     tags:
-     *     - User
-     *     summary: Get user
-     *     description: Returns a user
-     *     security:
-     *     - JWT: []
-     *     responses:
-     *       200:
-     *         description: User
-     *         schema:
-     *           type: object
-     *           title: UserResponse
-     *           properties:
-     *             success:
-     *               type: boolean
-     *             message:
-     *               type: string
-     *             data:
-     *               type: object
-     *               $ref: "#/definitions/User"
-     */
     @Get('/:id')
     public async findOne( @Response() res: my.Response, @RequestParam('id') id: string): Promise<any> {
         log.debug('findOne ', id);
         const user = await this.userService.findOne(parseInt(id, 10));
         return res.found(user.toJSON());
     }
 
-    /**
-     * @swagger
-     * /user/{id}:
-     *   put:
-     *     tags:
-     *     - User
-     *     summary: Update user
-     *     description: Returns a user
-     *     security:
-     *     - JWT: []
-     *     parameters:
-     *     - name: "id"
-     *       in: "path"
-     *       description: "ID of user to return"
-     *       required: true
-     *       type: "integer"
-     *       format: "int64"
-     *     - in: "body"
-     *       name: "body"
-     *       description: "User object"
-     *       required: true
-     *       schema:
-     *         $ref: "#/definitions/NewUser"
-     *     responses:
-     *       200:
-     *         description: User
-     *         schema:
-     *           type: object
-     *           title: UserResponse
-     *           properties:
-     *             success:
-     *               type: boolean
-     *             message:
-     *               type: string
-     *             data:
-     *               type: object
-     *               $ref: "#/definitions/User"
-     */
     @Put('/:id')
     public async update( @Response() res: my.Response, @RequestParam('id') id: string, @RequestBody() body: any): Promise<any> {
         log.debug('update ', body);
         const user = await this.userService.update(parseInt(id, 10), body);
         return res.updated(user.toJSON());
     }
 
-    /**
-     * @swagger
-     * /user/{id}:
-     *   delete:
-     *     tags:
-     *     - User
-     *     summary: Delete user
-     *     description: Returns a user
-     *     security:
-     *     - JWT: []
-     *     parameters:
-     *     - name: "id"
-     *       in: "path"
-     *       description: "ID of user to return"
-     *       required: true
-     *       type: "integer"
-     *       format: "int64"
-     *     responses:
-     *       200:
-     *         description: User
-     *         schema:
-     *           type: object
-     *           title: UserResponse
-     *           properties:
-     *             success:
-     *               type: boolean
-     *             message:
-     *               type: string
-     *             data:
-     *               type: object
-     *               example:
-     */
     @Delete('/:id')
     public async destroy( @Response() res: my.Response, @RequestParam('id') id: string): Promise<any> {
         log.debug('destroy ', id);