soon-serve
v0.0.5
Published
一个轻量级的本地开发服务器工具,用于快速启动静态资源服务或代理后端接口,适用于前端开发调试场景。
Readme
soon-serve
一个轻量级的本地开发服务器工具,用于快速启动静态资源服务或代理后端接口,适用于前端开发调试场景。
功能特点
- 🚀 快速启动本地 HTTP 服务器
- 📁 支持静态文件托管
- 🔗 内置 CORS 支持,解决跨域问题
- ⚙️ 命令行参数自定义配置(端口、路径等)
- 🔁 API 代理功能,支持路径重写
- 🌐 自动打开浏览器
- 📦 零依赖,纯 Node.js 实现
使用方法
基础使用
# 在当前目录启动服务
soon-serve
# 指定目录启动服务
soon-serve -s ./public
# 指定端口启动服务
soon-serve -p 3000
# 启动服务并自动打开浏览器
soon-serve -o命令行参数
| 参数 | 全称 | 描述 | 示例 |
|------|------|------|------|
| -p | --port | 指定端口号(末尾加 f 可禁用自动递增) | -p 3000 或 -p 3000f |
| -s | --serve | 指定服务目录 | -s ./dist |
| -r | --rewrites | 配置代理规则 | -r /api->http://localhost:8080 |
| -b | --base | 设置基础路径 | -b /app |
| -o | --open | 自动打开浏览器(可指定路径) | -o 或 -o /admin |
代理规则详解
soon-serve 支持强大的 API 代理功能,可以解决开发过程中的跨域问题。以下是几种常见的代理规则配置方式:
1. 基础代理
将特定路径的所有请求代理到目标服务器:
# 将 /api 开头的所有请求代理到 http://localhost:8080
soon-serve -r /api->http://localhost:8080/api
# 示例:
# /api/users -> http://localhost:8080/api/users
# /api/products/123 -> http://localhost:8080/api/products/1232. 多路径代理到同一目标
将多个路径前缀的请求代理到同一个目标服务器:
# 将 /api 和 /upload 的请求都代理到 http://localhost:8080
soon-serve -r /api,/upload->http://localhost:8080
# 或者使用多个 -r 参数
soon-serve -r /api->http://localhost:8080/api -r /upload->http://localhost:8080/upload3. 多个独立代理规则
配置多个不同的代理规则:
# 分别配置不同路径的代理规则
soon-serve -r /api->http://localhost:8080 -r /upload->http://localhost:9000
# 示例:
# /api/users -> http://localhost:8080/users
# /upload/image.png -> http://localhost:9000/image.png