Feature(mock): rewrite mock-server base on REST and Swagger

* Use faker instead of mock.js
* Use express server to host the fake data
* Support swagger config file
* Based on REST api

Author: Armour

.env.production

@@ -1,2 +1,4 @@
 # Base api
-VUE_APP_BASE_API = '/prod-api'
+# Remeber to change this to your production server address
+# Here I used my mock server for this project
+VUE_APP_BASE_API = 'https://vue-typescript-admin-mock-server.armour.now.sh/mock-api/v1/'

mock/api.ts

@@ -0,0 +1,4 @@
+export * from './articles'
+export * from './role'
+export * from './transactions'
+export * from './users'

mock/article.ts

@@ -0,0 +1,113 @@
+import faker from 'faker'
+import { Response, Request } from 'express'
+import { IArticleData } from '../src/api/types'
+
+const articleList: IArticleData[] = []
+const articleCount = 100
+const mockFullContent = '<p>I am testing data, I am testing data.</p><p><img src="https://wpimg.wallstcn.com/4c69009c-0fd4-4153-b112-6cb53d1cf943"></p>'
+
+for (let i = 0; i < articleCount; i++) {
+  articleList.push({
+    id: i,
+    status: faker.random.arrayElement(['published', 'draft', 'deleted']),
+    title: faker.lorem.sentence(6, 10),
+    abstractContent: faker.lorem.sentences(2),
+    fullContent: mockFullContent,
+    sourceURL: faker.internet.url(),
+    imageURL: faker.image.imageUrl(),
+    timestamp: faker.date.past().getTime(),
+    platforms: [faker.random.arrayElement(['a-platform', 'b-platform', 'c-platform'])],
+    disableComment: faker.random.boolean(),
+    importance: faker.random.number({ min: 1, max: 3}),
+    author: faker.name.findName(),
+    reviewer: faker.name.findName(),
+    type: faker.random.arrayElement(['CN', 'US', 'JP', 'EU']),
+    pageviews: faker.random.number({ min: 300, max: 500 })
+  })
+}
+
+export const getArticles = (req: Request, res: Response) => {
+  const { importance, type, title, page = 1, limit = 20, sort } = req.query
+
+  let mockList = articleList.filter(item => {
+    if (importance && item.importance !== +importance) return false
+    if (type && item.type !== type) return false
+    if (title && item.title.indexOf(title) < 0) return false
+    return true
+  })
+
+  if (sort === '-id') {
+    mockList = mockList.reverse()
+  }
+
+  const pageList = mockList.filter((_, index) => index < limit * page && index >= limit * (page - 1))
+
+  return res.json({
+    code: 20000,
+    data: {
+      total: mockList.length,
+      items: pageList
+    }
+  })
+}
+
+export const getArticle = (req: Request, res: Response) => {
+  const { id } = req.params
+  for (const article of articleList) {
+    if (article.id.toString() === id) {
+      return res.json({
+        code: 20000,
+        data: article
+      })
+    }
+  }
+  return res.json({
+    code: 70001,
+    message: 'Article not found'
+  })
+}
+
+export const createArticle = (req: Request, res: Response) => {
+  const { data } = req.body
+  return res.json({
+    code: 20000,
+    data
+  })
+}
+
+export const updateArticle = (req: Request, res: Response) => {
+  const { id } = req.params
+  const { data } = req.body
+  for (const article of articleList) {
+    if (article.id.toString() === id) {
+      return res.json({
+        code: 20000,
+        data
+      })
+    }
+  }
+  return res.json({
+    code: 70001,
+    message: 'Article not found'
+  })
+}
+
+export const deleteArticle = (req: Request, res: Response) => {
+  return res.json({
+    code: 20000,
+  })
+}
+
+export const getPageviews = (req: Request, res: Response) => {
+  return res.json({
+    code: 20000,
+    data: {
+      pageviews: [
+        { key: 'PC', pageviews: 1024 },
+        { key: 'Mobile', pageviews: 1024 },
+        { key: 'iOS', pageviews: 1024 },
+        { key: 'Android', pageviews: 1024 }
+      ]
+    }
+  })
+}

mock/articles.ts

@@ -0,0 +1,84 @@
+import express from 'express'
+import bodyParser from 'body-parser'
+import compression from 'compression'
+import morgan from 'morgan'
+import cors from 'cors'
+import http from 'http'
+import path from 'path'
+import yaml from 'yamljs'
+import * as api from './api'
+import { accessTokenAuth } from './security'
+
+const app = express()
+const port = 9528
+const { connector, summarise } = require('swagger-routes-express')
+
+// Compression
+app.use(compression())
+// Logger
+app.use(morgan('dev'))
+// Enable CORS
+app.use(cors())
+// POST, PUT, DELETE body parser
+app.use(bodyParser.json({ limit: '20mb' }))
+app.use(bodyParser.urlencoded({
+  limit: '20mb',
+  extended: false
+}))
+// No cache
+app.use((req, res, next) => {
+  res.header('Cache-Control', 'private, no-cache, no-store, must-revalidate')
+  res.header('Pragma', 'no-cache')
+  res.header('Expires', '-1')
+  next()
+})
+
+// Read and swagger config file
+const apiDefinition = yaml.load(path.resolve(__dirname, 'swagger.yml'))
+// Create mock functions based on swaggerConfig
+const options = {
+  security: {
+    AccessTokenAuth: accessTokenAuth
+  }
+}
+const connectSwagger = connector(api, apiDefinition, options)
+connectSwagger(app)
+// Print swagger router api summary
+const apiSummary = summarise(apiDefinition)
+console.log(apiSummary)
+
+// Catch 404 error
+app.use((req, res, next) => {
+  const err = new Error('Not Found')
+  res.status(404).json({
+    message: err.message,
+    error: err
+  })
+})
+
+// Create HTTP server.
+const server = http.createServer(app)
+
+// Listen on provided port, on all network interfaces.
+server.listen(port)
+server.on('error', onError)
+console.log('Mock server started on port ' + port + '!')
+
+// Event listener for HTTP server "error" event.
+function onError(error: any) {
+  if (error.syscall !== 'listen') {
+    throw error
+  }
+  const bind = typeof port === 'string' ? 'Pipe ' + port : 'Port ' + port
+  // handle specific listen errors with friendly messages
+  switch (error.code) {
+    case 'EACCES':
+      console.error('Express ERROR (app) : %s requires elevated privileges', bind)
+      process.exit(1)
+    case 'EADDRINUSE':
+      console.error('Express ERROR (app) : %s is already in use', bind)
+      process.exit(1)
+    default:
+      throw error
+  }
+}