ssl-server

Sumor Cloud 的工具。
更多文档

带 Express 的 SSL Web 服务器,支持 HTTP/2

CI 测试 覆盖率 审核

安装

npm i @sumor/ssl-server --save

先决条件

Node.JS 版本

要求 Node.JS 版本为 16.x 或更高

要求 Node.JS ES 模块

由于此包是使用 ES 模块编写的,请在您的 package.json 文件中更改以下代码:

{
  "type": "module"
}

使用

运行一个简单的服务器

import createApp from '@sumor/ssl-server'
const app = createApp()

// 默认监听端口 443,并将 80 重定向到 https 443
await app.listen()

添加 SSL 文件

请将 SSL 文件添加到根文件夹 ssl,文件名如下:

如果找不到这些文件,服务器将生成自签名证书。
如果 SSL 文件发生变化,它将自动重新加载。

特性

它支持所有 express 的功能,唯一的区别是 listenclose 方法。请参考下面的示例以获取更多细节。

添加中间件和路由

import createApp from '@sumor/ssl-server'
const app = createApp()
import bodyParser from 'body-parser'

// 您可以添加任何 express 中间件
app.use(bodyParser.json())

// 添加路由
app.get('/', (req, res) => {
  res.send('Hello World!')
})

// listen 是异步函数
await app.listen()

强制关闭服务器

import createApp from '@sumor/ssl-server'
const app = createApp()

// listen 是异步函数
await app.listen()
// close 是异步函数
await app.close()

监听自定义端口

import createApp from '@sumor/ssl-server'
const app = createApp()

// listen 是异步函数
await app.listen(8443, 8080)
console.log(`服务器正在运行 https://localhost:8443/`)
console.log(`重定向服务器正在运行 http://localhost:8080/`)