请求约定

服务器地址

场景 Base URL
管理 API http(s)://<host>:<port>/api/v1
站点内容 API <站点根>:域名路由为 /,路径前缀路由为 /:name/

管理 API 的 Uri 均相对 /api/v1 前缀;站点内容 API 的 Uri 均相对站点根。服务器是否启用 HTTPS 由其 TLS 配置决定。

认证

管理 API 全部要求 Bearer Token 认证:

Authorization: Bearer <token>

Token 在服务器配置中设置。站点内容 API 无需认证。

请求格式

接口类型 请求格式
常规管理接口 JSON(Content-Type: application/json)
产物上传接口 Multipart(Content-Type: multipart/form-data)
站点内容接口 无请求体

命名约束

对象 约束
站点名 ^[a-z][a-z0-9-]*$,全局唯一;api 为保留名,不可注册
域名 全局唯一,同一时刻只能绑定到一个站点