首页
/ 浏览器ify服务化(browserify-as-a-service)技术文档

浏览器ify服务化(browserify-as-a-service)技术文档

2024-12-24 21:18:59作者:袁立春Spencer

1. 安装指南

该项目无需安装,它是一个基于Web的服务,你可以直接通过URL访问和使用它。如果你需要在本地运行或自定义这个服务,你可以通过以下方式在Heroku或Docker上部署:

Heroku安装

heroku create my-browserify-cdn
git push heroku master
heroku ps:scale web=1

Docker安装

docker build -t "wzrd.in" /path/to/wzrd.in
docker run -p 8080:8080 wzrd.in

请注意,Docker部署将会在每次新部署时清除缓存。

2. 项目使用说明

该项目提供了一个简单的API,用于生成浏览器版本的JavaScript模块。你可以通过访问特定的URL来获取已缓存模块的束(bundle),或者请求创建一个新的模块束。

例如,你可以通过以下URL获取concat-stream模块的最新版本:

https://wzrd.in/standalone/concat-stream@latest

如果你访问的模块之前没有人访问过,它将从npm拉取模块,将其浏览器化,然后发送给你,并将其缓存以便下次使用。

3. 项目API使用文档

以下是可用的API端点:

GET /bundle/:module

获取:module的最新版本。

GET /bundle/:module@:version

获取满足给定:version:module版本,默认为最新版本。

GET /debug-bundle/:module

GET /debug-bundle/:module@:version

与上述两个相同,但向browserify传递了--debug参数。

GET /standalone/:module

GET /standalone/:module@:version

在这种情况下,向browserify传递了--standalone参数。

GET /debug-standalone/:module

GET /debug-standalone/:module@:version

向browserify传递了--debug--standalone参数。

POST /multi

发送一个如下所示的请求体:

{
  "options": {
    "debug": true
  },
  "dependencies": {
    "concat-stream": "0.1.x",
    "hyperstream": "0.2.x"
  }
}

"options"允许你设置"debug"、"standalone"和"fullPaths"。如果不定义"options",默认为{ "debug": false, "standalone": false, "fullPaths": false }

返回的响应可能如下所示:

{
  "concat-stream": {
    "package": /* the concat-stream package.json */,
    "bundle": /* the concat-stream bundle */
  },
  "hyperstream": {
    "package": /* the hyperstream package.json */,
    "bundle": /* the hyperstream bundle */
  }
}

该束将被永久缓存,以便将来通过GET请求访问。

GET /multi/:existing-bundle

如果你之前保存了POST请求的Location URL,你可以直接通过GET请求来访问它,而不是再次POST。

GET /status/:module

GET /status/:module@:version

获取模块的构建状态信息。返回满足给定semver的所有版本的构建信息(或者如果缺少semver,则为最新版本)。

返回的Blob通常如下所示:

{
  "module": "concat-stream",
  "builds": {
    "1.4.1": {
      "ok": true
    }
  }
}

"module"和"builds"字段应该都存在。"builds"的键是版本。属性包括:

  • "ok":包是否最后一次构建成功
  • "error":如果包构建失败("ok"为false),此属性将包含关于错误的信息

未构建的版本将不会在"builds"中键入。

4. 项目安装方式

该项目作为一个Web服务运行,因此不需要传统意义上的安装。你可以通过提供的URL直接使用它,或者按照上面的说明在Heroku或Docker上部署自己的实例。

登录后查看全文
热门项目推荐

项目优选

收起
kernelkernel
deepin linux kernel
C
22
6
docsdocs
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
164
2.05 K
nop-entropynop-entropy
Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0
leetcodeleetcode
🔥LeetCode solutions in any programming language | 多种编程语言实现 LeetCode、《剑指 Offer(第 2 版)》、《程序员面试金典(第 6 版)》题解
Java
60
16
RuoYi-Vue3RuoYi-Vue3
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
952
560
apintoapinto
基于golang开发的网关。具有各种插件,可以自行扩展,即插即用。此外,它可以快速帮助企业管理API服务,提高API服务的稳定性和安全性。
Go
22
0
openHiTLSopenHiTLS
旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
1.01 K
396
HarmonyOS-ExamplesHarmonyOS-Examples
本仓将收集和展示仓颉鸿蒙应用示例代码,欢迎大家投稿,在仓颉鸿蒙社区展现你的妙趣设计!
Cangjie
407
387
ohos_react_nativeohos_react_native
React Native鸿蒙化仓库
C++
199
279
giteagitea
喝着茶写代码!最易用的自托管一站式代码托管平台,包含Git托管,代码审查,团队协作,软件包和CI/CD。
Go
17
0