Express 基於 Node.js 平臺，快速、開放、極簡的 Web 開發框架

初始化目錄:

npm init
複製代碼

安裝 Express:

npm install express --save
複製代碼

HelloWorld:

建立app.js

//導入express
const  express = require('express')
//建立app對象
const app = express()
//構建請求
app.get('/',(req, res)=>res.send('hello world'))
//配置app監聽3000端口
app.listen(3000, ()=>console.log('Example app listening on port 3000!'))
複製代碼

快速建立應用的骨架-Express 應用程序生成器

全局安裝生成器(express-generator)

npm install express-generator -g
複製代碼

使用生成器建立項目

express --view=pug service-manage
複製代碼

安裝依賴

cd service-manage
npm install
複製代碼

啓動應用

//MacOS/Linux 默認監聽3000端口
DEBUG=service-manage:* npm start
//Windows 默認監聽3000端口
set DEBUG=service-manage:* & npm start
複製代碼

路由基本配置

1. 路由文件routes->tools.js

var express = require('express')
//獲取路由實例
var router = express.Router();

/* tools listing */
router.get('/',function (req, res ,next) {
    res.send('Welcome to visit tools... ')
})

router.post('/', function (req, res) {
    res.send('Got a POST request')
})

router.put('/user', function (req, res) {
    res.send('Got a PUT request at /user')
})

router.delete('/user', function (req, res) {
    res.send('Got a DELETE request at /user')
})
//導出tools路由
module.exports = router
複製代碼

2. app.js配置新路由文件

//導入toolsRouter模塊
var toolsRouter = require('./routes/tools');
//添加路由規則
app.use('/tools', toolsRouter)
複製代碼

路由配置

router.all() 對路由規則相同路由進行預處理

router.all('/', function (req, res, next) {
    console.log('Accessing the secret section ...')
    next() // pass control to the next handler
})
複製代碼

請求參數

配置

router.get('/users/:userId/books/:bookId',function (req, res ,next) {
    res.send(req.params)
})
複製代碼

Test

Route path: /users/:userId/books/:bookId
Request URL: http://localhost:3000/users/34/books/8989
req.params: { "userId": "34", "bookId": "8989" }
複製代碼

後臺開發必作之Swagger配置

1、安裝:

npm i express-swagger-generator --save-dev
複製代碼

2、基本配置

const express = require('express');
const app = express();
const expressSwagger = require('express-swagger-generator')(app);

let options = {
    swaggerDefinition: {
        info: {
            description: 'This is a sample server',
            title: 'Swagger',
            version: '1.0.0',
        },
        host: 'localhost:3000',
        basePath: '/v1',
        produces: [
            "application/json",
            "application/xml"
        ],
        schemes: ['http', 'https'],
		securityDefinitions: {
            JWT: {
                type: 'apiKey',
                in: 'header',
                name: 'Authorization',
                description: "",
            }
        }
    },
    basedir: __dirname, //app absolute path
    files: ['./routes/**/*.js'] //Path to the API handle folder
};
expressSwagger(options)
app.listen(3000);
複製代碼

3、查看預覽

http://localhost:3000/api-docs/api-docs
複製代碼

4、swagger.io

http://editor.swagger.io/#
複製代碼

後臺開發必作之Swagger配置2

安裝:

npm install swagger-jsdoc swagger-ui-express --save
複製代碼

項目目錄新增config.js

// swagger配置信息
exports.swaggerConfig = {
    openapi: '3.0.0',
    title: 'Node Service API',
    version: '1.0.0',
    apis: ['./routes/*.js'],
    routerPath: '/api-docs'
}
複製代碼

項目目錄新增\swagger\index.js\

var swaggerUi = require('swagger-ui-express');
var swaggerJSDoc = require('swagger-jsdoc');
var config = require('../config')

exports.setSwagger = function (app) {
    const options = {
        definition: {
            openapi: config.swaggerConfig.openapi,
            info: {
                title: config.swaggerConfig.title,
                version: config.swaggerConfig.version
            }
        },
        apis: config.swaggerConfig.apis
    }

    const swaggerSpec = swaggerJSDoc(options)

    app.get('/api-docs.json', (req, res) => {
        res.setHeader('Content-Type', 'application/json')
        res.send(swaggerSpec)
    })
    app.use(config.swaggerConfig.routerPath, swaggerUi.serve, swaggerUi.setup(swaggerSpec))
}
複製代碼

app.js配置

var swaggerConfig = require('./swagger')
...
var app = express();
...
swaggerConfig.setSwagger(app)
複製代碼

PM2使用

安裝:

npm install pm2 -g
複製代碼

啓動:

pm2 start app.js
複製代碼

其餘:

pm2 list

pm2 stop 0

pm2 restart 0

pm2 show 0

pm2 delete 0
複製代碼