add swagger

gulpfile.js

@@ -80,7 +80,7 @@ gulp.task(GENERATE_DOC, gulp.series(CLEAN_DOC, function () {
   return gulp.src(TS_SRC_GLOB)
     .pipe(typedoc({
       out: "docs",
-      target: "es5",
+      target: "es6",
       name: "Express + Sequelize",
       module: "commonjs",
       readme: "readme.md",

package.json

 {
-    "name": "typescript-express-sequelize",
-    "version": "2.1.0",
-    "description": "Sample project with Express + Sequelize + Typescript",
-    "homepage": "https://github.com/maximegris/typescript-express-sequelize",
+    "name": "typescript-express-postgresql-sequelize",
+    "version": "1.0.0",
+    "description": "A sample project with Express + Sequelize + Typescript + Postgresql",
+    "homepage": "",
     "author": {
-        "name": "Maxime GRIS",
-        "email": "maxime.gris@gmail.com"
+        "name": "Author",
+        "email": "email@yourdomain.com"
     },
     "main": "build/src/server.js",
     "keywords": [
@@ -34,15 +34,17 @@
     "dependencies": {
         "body-parser": "1.19.0",
         "cors": "2.8.5",
-        "cross-env": "7.0.0",
+        "cross-env": "^7.0.0",
         "express": "4.17.1",
         "express-boom": "3.0.0",
-        "kafka-node": "^5.0.0",
         "express-validator": "^6.9.2",
+        "kafka-node": "^5.0.0",
         "morgan": "1.9.1",
         "pg": "^8.5.1",
         "pg-hstore": "^2.3.3",
         "sequelize": "^6.5.0",
+        "swagger-jsdoc": "^6.0.7",
+        "swagger-ui-express": "^4.1.4",
         "uuid": "3.4.0",
         "winston": "3.2.1"
     },

src/config.json

-{
-    "development": {
-        "username": "postgres",
-        "password": "meu@sds12@!#gh",
-        "database": "chinguyen_nodejs-practice",
-        "host": "27.74.255.96",
-        "port": 5430,
-        "dialect": "postgres"
-    }
-}
\ No newline at end of file

src/dao/_index.ts

 import * as LanguagesDao from './languages'
 import * as AppUserDao from './appusers'
 import * as StudentDao from './students'
-import * as ConsumerDao from '../kafka/consumerMessage'
-import * as ProducerDao from '../kafka/messageProducer'
+// For kafka only
+// import * as ConsumerDao from '../kafka/consumerMessage'
+// import * as ProducerDao from '../kafka/messageProducer'
 
 export { LanguagesDao }
 export { AppUserDao }
 export { StudentDao }
-export { ConsumerDao }
-export { ProducerDao }
+// For kafka only
+// export { ConsumerDao }
+// export { ProducerDao }

src/dao/students.ts

 import * as uuid from 'uuid'
 import { Students } from './../sqlz/models/students'
-import { where, Op } from 'sequelize/types';
+import { where, Op } from 'sequelize/types'
 import { Request, Response } from 'express'
 
 export function create(students: any): Promise<any> {
-    return Students.create({
-        id: uuid.v1(),
-        code: students.code,
-        firstname: students.firstname,
-        lastname: students.lastname,
-        email: students.email,
-        sdt: students.sdt
-        
-    })
+  return Students.create({
+    id: uuid.v1(),
+    code: students.code,
+    firstname: students.firstname,
+    lastname: students.lastname,
+    email: students.email,
+    sdt: students.sdt
+  })
 }
 export function findAll(): Promise<any> {
-    return Students.findAll()
+  return Students.findAll()
 
 }
 
- export function findStudentPagination (page:any, pagesize:any): Promise<any>{
-    return Students.findAndCountAll({
-        offset: (page - 1 ) * pagesize,
-        limit: pagesize
-        //offset: 1,
-        //limit: 2
-    })
-    
- }
+export function findStudentPagination(page: any, pagesize: any): Promise<any> {
+  return Students.findAndCountAll({
+    offset: (page - 1) * pagesize,
+    limit: pagesize
+    //offset: 1,
+    //limit: 2
+  })
 
-    
+}
 
 export function deleteUser(code: any): Promise<any> {
-    return Students.destroy({
-        where:{code}
-    })
+  return Students.destroy({
+    where: { code }
+  })
 }
 
 export function updateUser(code: any, students: any): Promise<any> {
-    return Students.findOne({
-        where: {code}
-    }).then(function(student) {
-        if (student) {
-            student.update({
-                firstname: students.firstname,
-                lastname: students.lastname,
-                email: students.email,
-                sdt: students.sdt
-            })
-        }
-    })
+  return Students.findOne({
+    where: { code }
+  }).then(function(student) {
+    if (student) {
+      student.update({
+        firstname: students.firstname,
+        lastname: students.lastname,
+        email: students.email,
+        sdt: students.sdt
+      })
+    }
+  })
 }

src/endpoints/_index.ts

 import * as LanguageController from './languages/_index'
 import * as AppUserController from './appusers/_index'
 import * as StudentsController from './students/_index'
-import * as ConsumerController from './consumer/_index'
-import * as ProducerController from './producer/_index'
+// For kafka only
+// import * as ConsumerController from './consumer/_index'
+// import * as ProducerController from './producer/_index'
 
-export { LanguageController, AppUserController, StudentsController, ConsumerController, ProducerController }
+export { LanguageController, AppUserController, StudentsController }

src/endpoints/consumer/_index.ts

-import * as ConsumerGet from './consumerMessage.get'
-
-
-export { ConsumerGet }
-

src/endpoints/consumer/consumerMessage.get.ts

-import { Request, Response } from 'express'
-import { ConsumerDao } from '../../dao/_index'
-
-export function getMessage(req: Request, res: Response) {
-  return ConsumerDao.receiveMessage();
-}

src/endpoints/producer/_index.ts

-import * as ProducerPost from './producerMessage.post'
-
-
-export { ProducerPost }

src/endpoints/producer/producerMessage.post.ts

-import { ProducerDao } from '../../dao/_index'
-import { Request, Response } from 'express'
-
-
-export function producer(req: Request, res: Response) {
-  return ProducerDao.produceMessage();
-}

src/kafka/consumerMessage.ts

-import * as kafka from 'kafka-node';
-//import {getConsumer} from './message'
-
-
-
-export function receiveMessage(): any {
-  const _that = this;
-  let topicName = 'message-chinguyen';
-  let produceTopic = topicName;
-  let kafkaConsumer = kafka.Consumer;
-  let Client = kafka.KafkaClient;
-  let client = new Client({ kafkaHost: 'localhost:9092' })
-
-  let consumer = new kafkaConsumer(client, [{ topic: produceTopic }], { autoCommit: false, fetchMaxWaitMs: 1000, fetchMaxBytes: 1024 * 1024 })
-
-  consumer.on('message', function(message) {
-    console.log(message);
-  });
-  consumer.on('error', function(err) {
-    console.log('error', err);
-  });
-}

src/kafka/message.ts

-import * as kafka from 'kafka-node';
-//import {} from 'optimist'
-
-let clientOpts = {
-  kafkaHost: 'localhost:9092',
-  //sasl: configuration.kafkaClient.sasl,
-  connectTimeout: 10000,
-  maxAsyncRequests: 10,
-  requestTimeout: 30000
-};
-// Create Producer
-let MessageProducer = kafka.Producer,
-  aaClient = new kafka.KafkaClient(clientOpts),
-  messageProducer = new MessageProducer(aaClient, { requireAcks: 1 })
-
-messageProducer.on('ready', function() {
-  setMessageProducer(messageProducer);
-});
-
-export function getMessageProducer(): kafka.Producer {
-  return messageProducer;
-}
-
-export function setMessageProducer(producerObj: kafka.Producer): void {
-  messageProducer = producerObj;
-}
-///
-

src/kafka/messageProducer.ts

-import { Producer } from 'kafka-node'
-import { getMessageProducer } from './message'
-
-export function produceMessage() {
-  const _that = this;
-  let producer = getMessageProducer();
-  let topicName = 'message-chinguyen';
-  let produceTopic = topicName;
-
-  let payloads: {
-    topic: any;
-    messages: any;
-    key: any;
-    attributes: any;
-    timestamp: any;
-  }[] = [];
-  let curTimestamp = Date.now();
-  payloads.push({ topic: produceTopic, messages: 'hahahahaha', key: 1, attributes: 'haha', timestamp: curTimestamp });
-
-  if (payloads.length > 0) {
-    producer.send(payloads, function(err, data) {
-      if (err) {
-        console.log("error");
-      }
-      else {
-        console.log("success");
-
-      }
-    });
-  }
-
-
-}

src/routes/appusers.ts

@@ -2,7 +2,16 @@ import { Express } from 'express'
 import { AppUserController } from '../endpoints/_index'
 
 export function routes(app: Express) {
-  app.get('/api/appUsers', AppUserController.AppUserGet.list)
-  app.post('/api/appUsers', AppUserController.AppUserPost.getValidationRules("CreateUser"), AppUserController.AppUserPost.createUser)
-  app.post('/api/appUsers/login', AppUserController.AppUserPost.getValidationRules("Login"), AppUserController.AppUserPost.login)
+  /**
+   * @swagger
+   * /api/users:
+   *  get:
+   *    description: Get all users
+   *    responses: 
+   *      '200':
+   *        description: A successful response
+   */
+  app.get('/api/users', AppUserController.AppUserGet.list)
+  app.post('/api/user', AppUserController.AppUserPost.getValidationRules('CreateUser'), AppUserController.AppUserPost.createUser)
+  app.post('/api/user/login', AppUserController.AppUserPost.getValidationRules('Login'), AppUserController.AppUserPost.login)
 }

src/routes/kafka.ts

-import { Express } from 'express'
-import { ConsumerController, ProducerController } from '../endpoints/_index'
-
-export function routes(app: Express) {
-  app.post('/api/producerMessage', ProducerController.ProducerPost.producer)
-  app.get('/api/consumerMessage', ConsumerController.ConsumerGet.getMessage)
-}

src/server.ts

@@ -6,6 +6,9 @@ import * as cors from 'cors'
 import { json, urlencoded } from 'body-parser'
 import { Express } from 'express'
 import * as routes from './routes/_index'
+import * as specs from './swagger'
+import * as swaggerUi from 'swagger-ui-express'
+
 
 const PORT: number = 3000
 
@@ -14,22 +17,23 @@ const PORT: number = 3000
  * Can be used for basic configurations, for instance starting up the server or registering middleware.
  */
 export class Server {
-
   private app: Express
 
   constructor() {
     this.app = express()
 
     // Express middleware
-    this.app.use(cors({
-      optionsSuccessStatus: 200
-    }))
-    this.app.use(urlencoded({
-      extended: true
-    }))
+    this.app.use(cors({ optionsSuccessStatus: 200 }))
+    this.app.use(urlencoded({ extended: true }))
+
     this.app.use(json())
     this.app.use(boom())
     this.app.use(morgan('combined'))
+
+    if (process.env["EnvironmentName"] == "development") {
+      this.app.use('/swagger', swaggerUi.serve, swaggerUi.setup(specs.default));
+    }
+
     this.app.listen(PORT, () => {
       winston.log('info', '--> Server successfully started at port %d', PORT)
     })

src/swagger.ts

+import * as swaggerJsdoc from 'swagger-jsdoc'
+
+const options = {
+  apis: ['**/*.ts'],
+  explorer: true,
+  swaggerDefinition: {
+    info: {
+      swagger: '2.0',
+      title: "Sample project APIs doc",
+      description: "Your project description here",
+      contact: {
+        name: "Author name"
+      },
+      version: '1.0.0'
+    }
+  }
+};
+
+const specs = swaggerJsdoc(options);
+export default specs;

tsconfig.json

@@ -5,6 +5,8 @@
     "module": "commonjs",
     "declaration": false,
     "noImplicitAny": false,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
     "removeComments": true,
     "noLib": false,
     "emitDecoratorMetadata": true,