杏树林X-Pages杏树林 · 网页发布服务
A SPACE FOR YOUR IDEAS

让创意，
即刻上线。

从一个页面，到一个完整网站。
让报告、作品与灵感，拥有一个可以分享的链接。

单页轻松发布多文件完整呈现一个链接，随时分享

API 文档

🔐 认证说明

重要：所有写入操作（部署和删除）都需要在请求头中包含有效的x-token认证令牌。 
x-token: your-secret-token

🛠 API接口文档

📄 单页HTML部署

POST https://pages.xingshulin.com/html/deploy

部署单个HTML页面到KV存储

请求参数 (Headers):

参数名类型必须说明
x-tokenstring是认证令牌，用于验证部署权限
htmlkeystring是站点名称/标识符，用于访问时的URL路径
titlestring否站点标题，用于元数据记录
descriptionstring否站点描述，用于元数据记录
Content-Typestring是必须为 text/html

请求体 (Body):

类型必须说明
text/html是完整的HTML内容
DELETE https://pages.xingshulin.com/html/delete

删除指定的HTML站点

请求参数:

参数名位置类型必须说明
x-tokenHeaderstring是认证令牌
siteNameQuerystring是要删除的站点名称
GET https://pages.xingshulin.com/{siteName}

访问部署的单页HTML站点（无需认证）

路径参数:

参数名类型必须说明
siteNamestring是站点名称，即部署时的 htmlkey 值

📦 ZIP压缩包部署（多文件Web应用）

POST https://pages.xingshulin.com/html/deploy-zip

部署ZIP压缩包到对象存储

请求参数 (Headers):

参数名类型必须说明
x-tokenstring是认证令牌，用于验证部署权限
htmlkeystring是应用名称/标识符，用于访问时的URL路径
titlestring否应用标题，用于元数据记录
descriptionstring否应用描述，用于元数据记录
Content-Typestring是原始 ZIP 使用 application/zip；Base64 使用 text/plain

请求体 (Body):

类型必须说明
binary是ZIP 原始字节；或设置 x-zip-encoding: base64 后发送整个 ZIP 的 Base64 文本
要求：ZIP包内必须包含 index.html 或 index.htm 文件。支持任意目录结构，会自动处理单一根目录的情况。
GET https://pages.xingshulin.com/app/{siteName}/{path}

访问ZIP部署的Web应用（无需认证）

路径参数:

参数名类型必须说明
siteNamestring是应用名称，即部署时的 htmlkey 值
pathstring否资源路径，默认为 index.html

访问示例:

https://pages.xingshulin.com/app/my-app/           → index.html
https://pages.xingshulin.com/app/my-app/styles.css → styles.css
https://pages.xingshulin.com/app/my-app/js/app.js  → js/app.js

💡 使用示例

1. 部署单页HTML站点

curl -X POST "https://pages.xingshulin.com/html/deploy" \
  -H "Content-Type: text/html" \
  -H "x-token: your-secret-token" \
  -H "htmlkey: hello-world" \
  -H "title: Hello World Site" \
  --data-raw "<!DOCTYPE html><html><body><h1>Hello!</h1></body></html>"

2. 访问单页HTML站点

curl "https://pages.xingshulin.com/hello-world"

3. 部署ZIP压缩包（多文件应用）

curl -X POST "https://pages.xingshulin.com/html/deploy-zip" \
  -H "Content-Type: application/zip" \
  -H "x-token: your-secret-token" \
  -H "htmlkey: my-webapp" \
  -H "title: My Web Application" \
  --data-binary "@./my-webapp.zip"

4. 访问ZIP部署的应用

curl "https://pages.xingshulin.com/app/my-webapp/"

5. 删除站点

curl -X DELETE "https://pages.xingshulin.com/html/delete?siteName=hello-world" \
  -H "x-token: your-secret-token"

Base64 文本上传

适用于仅支持文本的代理。先将整份 ZIP 编码为标准 Base64，保持目录结构。认证和发布 ID 不变。

curl -X POST "https://pages.xingshulin.com/html/deploy-zip" \
  -H "x-token: your-secret-token" \
  -H "htmlkey: your-site-uuid" \
  -H "x-zip-encoding: base64" \
  -H "Content-Type: text/plain; charset=utf-8" \
  --data-binary @app.zip.b64

请勿使用 multipart / -F。默认 ZIP 上限 20 MiB，声明解压总量上限 100 MiB；大小超限返回 413，编码或 ZIP 无效返回 400。