Webrender：修订间差异

2024年2月7日 (三) 09:22的版本

Webrender 为小可的外置服务。主要用于处理 Wiki infobox 图片渲染、 html 渲染以及部分功能的访问代理。

此服务使用 JavaScript 编写，并由 Puppeteer 驱动，因此需要安装 Node.js 环境，以及安装 Chromium 内核浏览器。

部署

请前往此处下载源文件，并在终端内使用 npm install 安装依赖。

前往此处下载任意版本 Chromium，或前往 Chromium 官方网站下载。

于 package.json 同级目录中，中新建 .env 文件，并填写以下字段：

CHROMIUM_PATH = # Chromium 可执行文件位置
FC_SERVER_PORT = 15551 # API 监听端口

使用 node 运行 ./src/index.js 来开启服务。

$ node ./src/index.js

API 监听端口默认位于 15551，可自行选择配置代理。

请在配置文件中 web_render 配置项填写访问地址，如http://127.0.0.1:15551/。

用法

以下为 Webrender API 的部分用法。

`/element_screenshot`

POST

此端点可以生成指定元素的网页截图。

请求参数

element：指定要截图的元素的 CSS 选择器，可以是单个选择器字符串或选择器字符串数组。
width（可选）：截图的宽度，默认 720px。
height（可选）：截图的高度，默认 1280px。
counttime（可选）：是否在截图中添加计时框，默认 true。
tracing（可选）：是否启用页面追踪，默认 false。
content（可选）：要加载到页面的 HTML 内容。
url（可选）：要加载的页面的 URL。
css（可选）：要应用于页面的自定义 CSS 样式。
elements_to_disable（可选）：要在页面中隐藏的元素的CSS选择器数

响应

如果响应成功，返回生成的页面截图。
如果响应失败，返回 500 错误。

`/page`

POST

此端点可以生成指定 URL 页面的截图。

请求参数

url：要加载的页面的 URL。
css（可选）：要应用于页面的自定义 CSS 样式。

响应

如果响应成功，返回生成的页面截图。
如果响应失败，返回 500 错误。

@@ 第27行： / 第27行： @@
 == 用法 ==
  以下为 Webrender API 的部分用法。
+===<code>/element_screenshot</code>===
+{{Instructor|
+* {{Instructor method|POST}}
+}}
+此端点可以生成指定元素的网页截图。
+==== 请求参数 ====
+* element：指定要截图的元素的 CSS 选择器，可以是单个选择器字符串或选择器字符串数组。
+* {{Instructor param|width|int}}（可选）：截图的宽度，默认 720px。
+* {{Instructor param|height|int}}（可选）：截图的高度，默认 1280px。
+* {{Instructor param|counttime|bool}}（可选）：是否在截图中添加计时框，默认 true。
+* {{Instructor param|tracing|bool}}（可选）：是否启用页面追踪，默认 false。
+* {{Instructor param|content|str}}（可选）：要加载到页面的 HTML 内容。
+* {{Instructor param|url|str}}（可选）：要加载的页面的 URL。
+* {{Instructor param|css|str}}（可选）：要应用于页面的自定义 CSS 样式。
+* elements_to_disable（可选）：要在页面中隐藏的元素的CSS选择器数
+==== 响应 ====
+* 如果响应成功，返回生成的页面截图。
+* 如果响应失败，返回 500 错误。
 ===<code>/page</code>===
@@ 第35行： / 第56行： @@
 ==== 请求参数 ====
-* {{Instructor param|url|str}}：要 生成截图 的页面的 URL。
+* {{Instructor param|url|str}}：要 加载 的页面的 URL。
 * {{Instructor param|css|str}}（可选）：要应用于页面的自定义 CSS 样式。