Skip to content

web

web功能包用于创建一个web服务器,提供了前端交互访问的http接口、web socketweb静态资源服务。

开始中创建了rsup的配置文件config.toml,其中包含了web服务的配置。

toml
[web]
port = 8888
static_dir = "/opt/rsup/web"

配置端口号默认8888,配置静态资源目录,默认为/opt/rsup/web(这是macos,windows系统查看)。

web服务提供的数据能力可以为自己所用,不使用默认提供的前端页面能力。可用于服务端、web端、桌面端。

http 服务

http请求接口前缀为/api,分功能模块,又分为:

  • /pkg 提供了获取当前项目依赖信息。
  • /env 提供获取当前环境下的node 版本信息,包括:npm版本、pnpm版本、yarn版本。

http请求统一响应格式为:

rust
#[derive(Deserialize, Serialize)]
pub struct ResParams<T> {
    success: bool,
    msg: String,
    data: Option<T>,
}
impl<T> ResParams<T> {
    pub fn ok(data: T) -> ResParams<T> {
        ResParams {
            success: true,
            data: Some(data),
            msg: String::from("ok"),
        }
    }
    pub fn err(msg: String) -> ResParams<T> {
        ResParams {
            success: false,
            data: None,
            msg,
        }
    }
}

/pkg

  • /get 返回所有依赖信息。
  • /update 更新指定的依赖到指定版本
  • /graph 查询指定依赖的依赖关系图。

/env

web socket 服务

主要用于获取当前项目依赖的最新版本信息,依赖信息是异步请求,前端页面实现加载状态。在请求完成后发送消息给前端。

Released under the Apache License.