X-Pages - HTML部署服务

📋 服务概述

X-Pages是一个强大的HTML部署服务，使用腾讯云EdgeOne的KV存储来管理和部署静态HTML内容。所有的部署和删除操作都需要通过x-token进行安全认证。

🔐 认证说明

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

Authorization: x-token: your-secret-token

🛠 API接口文档

📄 单页HTML部署

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

部署单个HTML页面到KV存储

请求参数 (Headers):

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

请求体 (Body):

类型	必须	说明
text/html	是	完整的HTML内容

DELETE https://pages.xingshulin.com/html/delete

删除指定的HTML站点

请求参数:

参数名	位置	类型	必须	说明
`x-token`	Header	string	是	认证令牌
`siteName`	Query	string	是	要删除的站点名称

GET https://pages.xingshulin.com/{siteName}

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

路径参数:

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

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

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

部署ZIP压缩包到腾讯云COS存储

请求参数 (Headers):

参数名	类型	必须	说明
`x-token`	string	是	认证令牌，用于验证部署权限
`htmlkey`	string	是	应用名称/标识符，用于访问时的URL路径
`title`	string	否	应用标题，用于元数据记录
`description`	string	否	应用描述，用于元数据记录
`Content-Type`	string	是	必须为 `application/zip`

请求体 (Body):

类型	必须	说明
binary	是	ZIP文件二进制内容

              要求：ZIP包内必须包含 index.html 或 index.htm 文件。支持任意目录结构，会自动处理单一根目录的情况。
            

GET https://pages.xingshulin.com/app/{siteName}/{path}

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

路径参数:

参数名	类型	必须	说明
`siteName`	string	是	应用名称，即部署时的 htmlkey 值
`path`	string	否	资源路径，默认为 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"

⚡ 特性

🔒 安全认证 - 基于x-token的权限校验
🚀 快速部署 - 即时部署HTML内容到EdgeOne
💾 双存储模式 - 单页HTML用KV存储，多文件应用用COS存储
📦 ZIP部署 - 支持上传ZIP压缩包部署完整Web应用
📊 元数据管理 - 支持自定义元数据和部署信息
🌐 全球加速 - 借助EdgeOne的全球节点加速访问
🎯 简洁访问 - 直接通过域名/站点名访问，无需复杂路径

🚀 X-Pages HTML部署服务